1. Criar um projeto para obter credenciais
2. Integrar as API e testar a sua implementação
3. Mover o seu projeto para a fase de produção
4. Concluir a sua certificação

Um administrador ou contribuidor da sua organização pode criar um projeto de API ao clicar no botão Criar um projeto de API.

Antes de começar, terá de nos informar acerca do motivo pelo qual precisa de aceder às API da FedEx. Será apresentada uma janela modal com uma lista de opções. Deve selecionar a opção que melhor identifica as suas necessidades empresariais para fazer a integração nas API da FedEx.

Caso se identifique como um expedidor, pode começar a criar o seu projeto. Existe um processo de três passos:

Selecionar API

Selecione a(s) API que pretende incluir no seu projeto. Com base na(s) API que selecionar, poderá ter de fazer algumas seleções adicionais.

Se selecionar a API de rastreio, também terá de:

• Selecionar um número de conta para associar à sua chave de produção.
• Rever as quotas da API de rastreio, os limites de tarifas e os detalhes de certificação da API.
• Escolher se pretende aceitar e-mails de notificação se exceder a sua quota de transação.

Configurar projeto

Introduza algumas especificações do projeto, incluindo o nome e a localização de expedição.

• Atribua ao seu projeto um nome que seja identificável e exclusivo da sua organização
• Selecione quaisquer países de onde pretende enviar para que lhe possamos atribuir uma conta de expedição de teste. Para testar a expedição de volumes a nível nacional num país europeu, é necessário ter uma conta de teste separada para cada país. Pode sempre adicionar/remover países mais tarde.
• Para receber notificações sobre as últimas atualizações de API e quaisquer informações relacionadas com interrupções, pode definir as suas preferências de notificação.

Confirmar os detalhes

Reveja os detalhes do seu projeto e, em seguida, aceite os Termos e condições.

• Leia e aceite o Contrato de licença do FedEx Developer Portal e confirme que não pretende vender ou distribuir a sua aplicação.
• Depois de clicar no botão "Criar", verá um ecrã de confirmação. Em seguida, poderá ver as suas credenciais de teste no seu novo projeto.

• Pedir um token de acesso OAuth, que tem de ser utilizado em cada transação da API. O token é válido apenas durante 1 hora, por isso terá de programar a sua aplicação para atualizar o token antes de a sessão expirar. Consulte os documentos de Autorização da API para obter mais detalhes
• Clique em quaisquer Documentos para as suas API para ler o contexto empresarial de cada API, de forma a compreender melhor como a utilizar. Também pode rever pedidos de exemplo para o ponto final que corresponde à integração que pretende.
• Implemente as suas chamadas nestes pontos finais conforme descrito nos pedidos de exemplo e configure-as com as credenciais de teste.
• Verifique se as respostas às chamadas de API que recebe correspondem às apresentadas na documentação.
• Teste a sua implementação no âmbito do ambiente de testes da FedEx através das suas credenciais e dos URL de teste da FedEx.

Dentro do passo Configurar projeto:

• Pode mudar o nome da sua chave conforme necessário.
• Reveja o número de conta que selecionou no passo 1 do fluxo de criação do projeto. Esse número é utilizado para mover o seu projeto para a fase de produção. Quando o seu projeto estiver nessa fase, pode adicionar mais contas conforme necessário.

Dentro do passo Obter chaves do projeto:

• A sua chave da API de produção e chave secreta de produção serão apresentadas. Certifique-se de que as copia para um local seguro.
• Para manter a sua chave secreta de produção em segurança, só apresentamos a mesma uma vez. Se a perder, pode gerar uma nova.
• Clique em Seguinte.

Agora, acederá novamente à página Descrição geral do projeto. Aqui pode adicionar mais contas associadas ao seu projeto.

Na página Descrição geral do projeto:

• Clique nos três pontos verticais (ou menu de opções) para adicionar mais contas associadas ao seu projeto.
• Em seguida, clique em Editar.

Acederá à página Chave da API, onde pode adicionar quaisquer contas adicionais que pretenda associar à sua chave de produção para este projeto.

1. Algumas API requerem certificação de etiquetas de expedição para serem utilizadas no nosso ambiente de produção. Conclua o processo de certificação de qualquer API no seu projeto que tenha este requisito.

1. Depois de todas as API terem sido certificadas e ativadas, atualize os seus pedidos de API ao substituir os URI, as chaves e as contas de expedição de teste pelos URI, chaves e contas de expedição de produção.

2. Volte a testar a implementação no ambiente de produção através de dados de amostra.

3. Desfrute das vantagens da nova integração!

Pré-requisitos para criar um projeto de webhook

1. Criar um URL válido na sua aplicação/plataforma de destino
2. Gerar um token de segurança
3. Testar o URL do webhook
4. Validar o URL de destino

Criar um projeto de webhook

1. Criar um projeto de webhook para receber notificações de cargas configuradas

Pré-requisitos para criar um projeto de webhook

Crie um URL válido na sua aplicação/plataforma de destino para receber códigos/mensagens de autenticação e notificações de cargas do Tracking webhook da FedEx.

Requisitos do URL:

Este token de segurança pode ser utilizado como uma chave secreta para autenticar e validar informações transmitidas entre si (o cliente) e a FedEx.

Requisitos do token de segurança:

• Um comprimento mínimo de 25 carateres e máximo de 100 carateres
• 1 caráter em maiúsculas
• 1 caráter em minúsculas
• 1 caráter numérico

Testar o seu URL é um passo opcional que pode considerar útil.

O teste pode ajudar a garantir que o URL que criou no passo 1 é válido. Permite que a FedEx identifique o seu URL e crie uma ligação ao mesmo para enviar dados. Além disso, pode fornecer-lhe dados de amostra de testes que podem ajudar a verificar e a confirmar se consegue processar dados de rastreio fornecidos na sua aplicação. No entanto, o teste não autentica o seu URL.

Consulte a nossa documentação sobre webhooks para saber mais sobre como testar o seu URL de webhook.

Através do método de algoritmo de hashing HMAC SHA256, configure um processo de autenticação para validar as informações transmitidas entre o seu URL de destino e a FedEx.

1. Quando clica em Criar, a FedEx gera uma cadeia de desafio aleatória, que é enviada para si no corpo do pedido. Tem, depois, de devolver esta cadeia de desafio à FedEx no corpo da resposta.

1. Inicie um código de autenticação de mensagem (MAC) através do procedimento/algoritmo HMAC SHA256 para fazer hashing (ou combinar) a cadeia de desafio e o token de segurança (ou chave secreta), para formar uma assinatura de hash

1. Responda à FedEx com a challengeString e a challengeStringResponse no corpo da resposta, juntamente com o código de estado HTTP 200 (OK) ou 202 (ACEITE).

1. Agora, a FedEx irá validar a cadeia de desafio e a resposta da cadeia de desafio.

• Após a FedEx receber o corpo de resposta, irá validar a challengeString e a challengeStringResponse (ou assinatura de hash gerada anteriormente) ao compará-las com a challengeString e a assinatura de hash gerada pela FedEx, respetivamente.

• Se as assinaturas da "challengeString" e do HMAC corresponderem, a validação e o fluxo de trabalho foram bem-sucedidos. Caso contrário, o processo de validação irá falhar e será apresentada uma mensagem de erro.

Criar um projeto de webhook

Na página Os meus projetos, aceda ao separador Webhooks.

Um administrador ou contribuidor da sua organização pode criar um projeto de webhook ao clicar no botão Criar um projeto de webhook.

Antes de começar, terá de nos informar acerca do motivo pelo qual precisa de aceder aos webhooks da FedEx. Será apresentada uma janela modal com uma lista de opções. Selecione a opção que melhor identifica as suas necessidades empresariais para fazer a integração nos webhooks da FedEx.

Caso se identifique como um expedidor, pode começar a criar o seu projeto ao concluir os seguintes passos:

1. Identificar as suas necessidades empresariais

• Selecione a opção que melhor identifica o motivo pelo qual a sua empresa pretende fazer a integração nos webhooks da FedEx.

1. Selecionar o escalão e as respetivas funcionalidades

• Selecione um escalão de webhook básico ou avançado para o seu projeto com base nas suas necessidades ao nível do projeto.
• Pode sempre editar a sua escolha de escalão mais tarde.
• Cada escalão inclui uma taxa de subscrição mensal.

• Selecione as funcionalidades que pretende que sejam configuradas com o seu projeto.
• Também pode editar as suas funcionalidades mais tarde.

1. Configurar os detalhes do projeto

• Atribua ao seu projeto um nome que seja identificável
• Forneça os detalhes do URL de destino pré-gerado e do token de segurança, que são criados durante a autenticação de pré-configuração.

Escolher as contas

• Escolha a partir de uma lista de números de conta elegíveis (dos EUA ou do Canadá) que pretende associar ao seu projeto.

  5. Confirmar os detalhes e aceitar os termos

• Reveja os seus detalhes do projeto configurado.
• Leia e aceite o Contrato de licença do Developer Portal e confirme que não pretende distribuir a sua aplicação.
• Leia e aceite o Acordo de preços.
• Quando clicar no botão Criar projeto:

1. Se o seu pedido de criação tiver sido validado e processado com êxito, acederá a um ecrã de confirmação.

• Se a validação não for bem-sucedida ou falhar, verá uma mensagem de erro.

1. Depois, o seu projeto do Tracking webhook terá uma ID de webhook gerada pelo sistema e será apresentado com um estado "Ativo".

1. A FedEx cria uma Organização de fornecedores compatíveis.
2. Aceite o convite.
3. Convide utilizadores para a sua organização.
4. Selecione as API de que precisa para a sua solução.
5. A FedEx cria projetos.
6. Integre as API na sua aplicação e obtenha certificação para o Programa Compatível.
7. A FedEx move os projetos para a fase de produção.
8. Gere a Chave Secreta de Produção.

• A FedEx irá criar uma organização e convidar um membro da equipa para juntar-se à organização. Este utilizador será designado o administrador da sua organização.
• Após a conclusão da certificação e da integração, poderá distribuir a solução aos seus clientes com facilidade.

• Para obter acesso à documentação e aos artefactos de integração da API, aceite o convite. Para aceitar o convite, terá de iniciar sessão com a sua ID de Utilizador e palavra-passe da FedEx ou criar uma nova se ainda não tiver credenciais.

• Como Administrador, pode convidar membros da equipa que precisam de acesso ao projeto ou à organização. Para obter detalhes sobre funções diferentes, consulte o Guia de Administração da Organização.

• Se a sua organização já tiver sido criada, peça à Administração da organização ou à FedEx que lhe envie um convite para se juntar à mesma. Terá 24 horas para aceitar o convite. Se ultrapassar este período de tempo, pode pedir que o convite seja novamente enviado.

• Aceda ao Catálogo de API para determinar as API certas para a sua solução. O Consultor de tecnologia do cliente FedEx (CTC) e o Gestor de canal compatível podem ajudar a selecionar as API adequadas para a sua solução, de acordo com as suas necessidades empresariais.

• Selecione uma API para descobrir a descrição geral, os registos de alterações e as principais funcionalidades.

• Veja a documentação da API para saber mais sobre os elementos de pedido e resposta, exemplos no seu idioma preferencial, objetos de erro e muito mais.

• Volte à Salesforce para preencher a Ficha de Informações do Produto (PIW) e indique as API que gostaria de adicionar à sua solução.

Assim que a PIW for aprovada, a FedEx irá criar os seus projetos. Cada versão de cada uma das suas soluções terá um projeto separado no FedEx Developer Portal. Se um utilizador não for um Administrador da organização, terá de ser convidado para ver cada projeto. 

É também nesta altura que a equipa do programa Compatível com a FedEx, juntamente com o CTC FedEx e as equipas de certificação, irá organizar uma demonstração técnica para as API com a sua equipa. A equipa FedEx irá debater as novas funcionalidades disponíveis com a versão das API que está a adotar. A equipa poderá abordar questões técnicas relativas às API, testes de API e todos os processos que precisam de ser concluídos para iniciar o processo de certificação* de API.

* Certificação – o processo definido pelo Programa Compatível com a FedEx para satisfazer os Requisitos de Conformidade do Programa. A Certificação de Programa Compatível é necessária para garantir que todos os Fornecedores Compatíveis implementam, comercializam e distribuem a tecnologia FedEx aos expedidores (clientes), conforme definido pelos padrões de serviço e tecnologia FedEx.

1. Terá agora acesso à Chave de API de Teste e à Chave Secreta de Teste para começar a executar transações. Pode recuperar as mesmas no separador Chave de Teste da página Descrição Geral do Projeto.

1. Para criar chaves de cliente, terá de utilizar a API de Registo de Credenciais, que é uma API privada apenas encontrada na secção API de cada um dos seus projetos.
2. Assim que criar algumas chaves de cliente, solicite um token de acesso OAuth para ser utilizado com cada transação da API. A sessão do token é válida apenas durante 1 hora, pelo que terá de programar a sua aplicação para atualizar o token antes de a sessão expirar. Para obter mais detalhes, consulte os documentos de Autorização da API. Ao visualizar o código de amostra, certifique-se de que escolhe "Revendedor" na lista de opções de amostras.

1. Selecione os documentos para as API na sua página Chaves de Teste e leia o contexto empresarial para compreender melhor como utilizar a API selecionada. Reveja os pedidos de exemplo para o ponto final que corresponde à integração que pretende.
2. Implemente as suas chamadas para estes pontos finais como descrito nos pedidos de exemplo e configure as mesmas para utilizar as suas credenciais de teste.
3. Certifique-se de que as respostas às chamadas à API recebidas estão de acordo com as apresentadas na documentação.
4. Teste a sua implementação de forma eficiente no âmbito do ambiente de testes FedEx, através das credenciais e dos URI de teste FedEx.
5. Depois de testar totalmente as suas soluções, certifique cada solução na Salesforce. A FedEx irá rever integralmente tudo o que for enviado e informá-lo assim que a sua certificação for aprovada.

• Em seguida, a FedEx irá mover os projetos para a fase de produção.
• Poderá ver a Chave de API de produção, no separador Chave de produção, na página Descrição geral do projeto.

• A sua Chave secreta de produção terá de ser gerada ao clicar na ligação Gerar chave secreta na coluna Chave secreta.
• Agora pode voltar a testar a implementação no ambiente de produção através de dados de amostra.
• Desfrute das vantagens da nova integração!