1. Criar um projeto para obter credenciais
2. Integrar APIs e testar a implementação
3. Colocar o projeto na produção
4. Concluir a certificação

Um administrador ou colaborador da sua organização pode criar um projeto de API clicando no botão Criar um Projeto de API.

Antes de começar, informe por que precisa acessar as APIs da FedEx. Um modal aparecerá e apresentará opções suspensas. Selecione a opção que melhor identifica as necessidades de sua empresa para integrar-se às APIs da FedEx.

Se você se identificar como remetente, poderá começar a criar o projeto. O processo tem três etapas:

Selecionar APIs

Selecione as APIs que deseja incluir no projeto. Dependendo das APIs selecionadas, talvez seja necessário fazer seleções adicionais.

Se você selecionar API de rastreamento, também precisará:

• Selecione um número da conta para associar à sua chave de produção.
• Revise as cotas da API de rastreamento, os limites de tarifa e os detalhes da certificação da API.
• Escolha se deseja ou não aceitar e-mails que notifiquem quando você exceder a cota de transações.

Configurar projeto

Informe algumas especificações do projeto, incluindo nome e localização de envio.

• Dê ao projeto um nome identificável exclusivo para sua organização.
• Selecione os países nos quais pretende enviar remessas para que possamos atribuir a você uma conta teste de envio. Para testar fazer envios domésticos em um país europeu, é preciso ter uma conta de teste para cada país. Você sempre poderá adicionar/remover países quando quiser.
• Para receber as atualizações mais recentes da API e outras informações relacionadas a interrupções, defina suas preferências de notificação.

Confirmar detalhes

Revise os detalhes do projeto e 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 nem distribuir o aplicativo.
• Depois de clicar no botão "Criar", você verá uma tela de confirmação. Você poderá visualizar suas credenciais de teste no novo projeto.

• Solicitar um token de acesso OAuth, que deve ser usado com cada transação da API. O token é válido apenas por uma hora, então você precisará codificar programaticamente seu aplicativo para atualizar o token antes que a sessão expire. Consulte os documentos de autorização da API para obter mais detalhes.
• Clique em qualquer documento das APIs para ler o contexto comercial de cada API e entender melhor como usá-la. Você também pode revisar solicitações de exemplo para o endpoint que corresponde à integração desejada.
• Implemente suas chamadas para esses endpoints, conforme descrito nas solicitações de exemplo, configurando-as com suas credenciais de teste.
• Verifique se as respostas de chamada da API recebidas correspondem às mostradas na documentação.
• Teste sua implementação no ambiente de teste da FedEx usando credenciais de teste e os URLs de teste da FedEx.

Na etapa Configurar projeto:

• Você pode renomear sua chave conforme necessário.
• Revise o número da conta selecionado na etapa 1 do fluxo de criação do projeto. Ele é usado para colocar seu projeto na produção. Depois que o projeto estiver em produção, você poderá adicionar mais contas conforme necessário.

Na etapa Obter chaves do projeto:

• A chave da API de produção e a chave secreta de produção serão mostradas. Copie-as para um local seguro.
• Para manter a chave secreta de produção segura, ela só aparece uma vez. Se você a perder, poderá gerar outra.
• Clique em Próximo.

Agora você voltará à página Visão geral do projeto. Aqui você pode adicionar mais contas associadas ao projeto.

Na página Visão geral do projeto:

• Clique nos três pontos verticais (ou menu kebab) para adicionar mais contas associadas ao projeto.
• Em seguida, clique em Editar.

Você chegará à página Chave de API, em que poderá incluir outras contas que queira associar a sua chave de produção para o projeto.

1. Algumas APIs exigem certificação de etiqueta de envio para uso em nosso ambiente de produção. Conclua o processo de certificação para quaisquer APIs em seu projeto com esse requisito.

1. Depois de certificar e habilitar todas as APIs, atualize as solicitações de API substituindo os URIs, chaves e contas de envio teste pelos URIs, chaves e contas de envio de produção.

2. Teste novamente sua implementação no ambiente de produção usando os dados de amostra.

3. Aproveite os benefícios da sua nova integração!

Pré-requisitos para criar um projeto de webhook

1. Crie um URL válido em seu aplicativo/plataforma de destino
2. Gerar token de segurança
3. Testar o URL do webhook
4. Validar URL de destino

Criar um projeto de webhook

1. Crie um projeto de webhook para receber notificações de carga útil configuradas

Pré-requisitos para criar um projeto de webhook

Crie um URL válido em seu aplicativo/plataforma de destino para receber da FedEx códigos/mensagens de autenticação e notificações de carga útil do webhook de rastreamento.

Requisitos de URL:

É possível usar o token de segurança como uma chave secreta para autenticar e validar informações transmitidas entre você (o cliente) e a FedEx.

Requisitos do token de segurança:

• comprimento mínimo de 25 caracteres e máximo de 100 caracteres
• Uma letra maiúscula
• Uma letra minúscula
• Um caractere numérico

Também vale a pena testar o URL, mas essa etapa é opcional.

Os testes podem ajudar você a saber se o URL criado na etapa 1 é válido. Isso permite que a FedEx identifique seu URL e crie uma conexão com ele para enviar dados. O teste também pode fornecer dados de teste de amostra que podem ajudar você a verificar e confirmar se é capaz de processar os dados de rastreamento fornecidos em seu aplicativo. No entanto, o teste não autentica seu URL.

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

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

1. Quando você clica em Criar, a FedEx gera uma sequência de desafio aleatória, que é enviada a você no corpo da solicitação. Espera-se, por sua vez, que você devolva essa sequência de desafio à FedEx no corpo da resposta.

1. Inicialize o código de autenticação de mensagem (MAC) usando o algoritmo/procedimento HMAC SHA256 para fazer hash (ou combinar) a sequência de desafio e o token de segurança (ou chave secreta) para formar uma assinatura hash

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

1. Agora a FedEx validará a sequência de desafio e a resposta da sequência desafio.

• Depois que o corpo da resposta for recebido pela FedEx, a FedEx validará a challengeString e a challengeStringResponse (ou a assinatura hash gerada anteriormente) comparando-as com a challengeString e a assinatura hash gerada pela FedEx, respectivamente.

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

Criar um projeto de webhook

Na página Meus projetos, vá para a guia Webhooks.

Um administrador ou colaborador da sua organização pode criar um projeto de webhook clicando no botão Criar um webhook.

Antes de começar, informe o motivo por que precisa acessar os webhooks da FedEx. Um modal aparecerá e apresentará opções suspensas. Selecione a opção que melhor identifica as necessidades de sua empresa para integrar-se aos webhooks da FedEx.

Se você se identificar como remetente, poderá começar a criar seu projeto concluindo as seguintes etapas:

1. Identificar as necessidades da sua empresa

• Selecione a opção que melhor identifica por que sua empresa deseja integrar-se aos webhooks da FedEx.

1. Selecionar o nível e os recursos do nível

• Selecione uma camada de webhook básica ou avançada para o projeto de acordo com as suas necessidades.
• Você poderá editar a escolha de nível quando quiser.
• Cada nível vem com uma taxa de assinatura mensal.

• Selecione os recursos que deseja configurar com o projeto.
• Você também pode editar os recursos posteriormente.

1. Configurar detalhes do projeto

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

Escolher contas

• Escolha, da lista, um dos números de conta elegíveis (estabelecido nos EUA ou Canadá) que deseja associar ao seu projeto.

  5. Confirmar os detalhes e aceitar os termos

• Revise os detalhes do projeto configurado.
• Leia e aceite o Contrato de Licença do Developer Portal e confirme que não pretende distribuir seu aplicativo.
• Leia e aceite os Termos do Contrato de Valores.
• Depois de clicar no botão Criar projeto:

1. Se a solicitação de criação tiver sido validada e processada com sucesso, você verá uma tela de confirmação.

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

1. Seu projeto de webhook de rastreamento terá uma ID de webhook gerada pelo sistema e terá um status "Ativo".

1. A FedEx cria uma organização de provedor compatível.
2. Aceite o convite.
3. Convide usuários para sua organização.
4. Selecione as APIs necessárias para sua solução.
5. A FedEx cria o(s) projeto(s).
6. Integre APIs ao seu aplicativo e obtenha a certificação de programa compatível.
7. A FedEx move o(s) projeto(s) para a produção.
8. Gere a chave secreta da produção.

• A FedEx criará uma organização e convidará um membro da equipe para participar dela. Esse usuário receberá a função de administrador da organização.
• Após a conclusão da certificação e da integração, você poderá distribuir facilmente a solução aos seus clientes.

• Para obter acesso aos componentes e documentos de integração da API, aceite o convite. Para aceitar o convite, você precisará fazer login com sua ID de usuário e senha da FedEx ou criar uma nova ID e uma nova senha se ainda não tiver credenciais.

• Como administrador, você poderá convidar qualquer membro da equipe que precise de acesso ao projeto ou à organização. Para obter detalhes sobre as diferentes funções, consulte o Guia para administração da organização.

• Se sua organização já tiver sido criada, peça para o administrador da organização ou para a FedEx convidar você. Você terá 24 horas para aceitar o convite, mas se perder esse prazo, poderá pedir que o convite seja enviado novamente.

• Acesse o Catálogo de APIs para determinar as APIs corretas para sua solução. Seu consultor de tecnologia do cliente (CTC) e gerente de canal compatível da FedEx podem ajudar você a selecionar as APIs certas para sua solução conforme as necessidades da sua empresa.

• Selecione uma API para descobrir a visão geral, os históricos de mudança e os principais recursos.

• Veja a documentação da API para conhecer os elementos de solicitação e resposta, exemplos na sua linguagem de programação preferida, códigos de erro e muito mais.

• Retorne ao Salesforce para preencher a planilha de informações do produto (PIW) e inserir as APIs que você gostaria que fossem adicionadas à sua solução.

Quando a PIW for aprovada, a FedEx criará seu(s) projeto(s). Cada versão de cada solução terá um projeto separado no FedEx Developer Portal. Se um usuário não for um administrador da organização, ele precisará ser convidado para visualizar cada projeto. 

O mesmo vale para quando a equipe de compatibilidade da FedEx e as equipes de CTC e certificação da FedEx organizarem uma demonstração técnica das APIs para sua equipe. A equipe da FedEx discutirá os novos recursos e funcionalidades disponíveis na versão das APIs que você começará a usar. A equipe abordará questões técnicas relacionadas às APIs, bem como o teste da API e todos os processos que precisam ser concluídos para começar as etapas de certificação* das APIs.

* Certificação – Processo definido pelo programa compatível da FedEx para atender aos requisitos de conformidade do programa. A certificação de programa compatível é necessária para garantir que todos os provedores compatíveis implementem, comercializem e distribuam a tecnologia da FedEx para os remetentes (clientes) conforme definido pelos padrões de tecnologia e serviço da FedEx.

1. Você terá acesso à chave de API de teste e à chave secreta de teste para começar a realizar transações. Você pode obtê-las na guia Chave de teste da página Visão geral do projeto.

1. Para criar chaves do cliente, você precisará usar a API de registro de credencial, que é uma API privativa encontrada apenas na seção da API de cada um dos seus projetos.
2. Depois de criar algumas chaves do cliente, prossiga e solicite um token de acesso OAuth para usar em todas as transações da API. A sessão para o token é válida apenas por uma hora; portanto, você precisará codificar programaticamente seu aplicativo para atualizar o token antes que a sessão expire. Consulte os documentos de Autorização da API para obter mais detalhes. Ao visualizar o código de amostra, escolha “Revendedor” no menu suspenso de amostras.

1. Selecione documentos para as APIs na sua página Chaves de teste e leia o contexto comercial para entender melhor como usar a API selecionada. Revise solicitações de exemplo para o terminal que corresponde à integração desejada.
2. Implemente suas chamadas para esses terminais, conforme descrito nas solicitações de exemplo, configurando-as para usar suas credenciais de teste.
3. Verifique se as respostas de chamada da API recebidas correspondem às mostradas na documentação.
4. Teste completamente sua implementação no ambiente de teste da FedEx usando credenciais de teste e os URIs de teste da FedEx.
5. Depois de testar completamente suas soluções, verifique se todas elas estão no Salesforce. A FedEx revisará tudo que foi enviado e atualizará você quando sua certificação for aprovada.

• Em seguida, a FedEx moverá seu(s) projeto(s) para a produção.
• Você poderá ver sua chave da API de produção na guia Chave de produção da página Visão geral do projeto.

• Será preciso gerar a chave secreta de produção. Para isso, clique no link Gerar chave secreta embaixo da coluna Chave secreta.
• Assim, você poderá testar novamente sua implementação no ambiente de produção usando os dados de amostra.
• Aproveite os benefícios da sua nova integração!