Fornecedor de integração da FedEx
Pré-requisito
Você deve ter um ID de usuário FedEx para acessar o FedEx Developer Portal e criar uma organização.
Ingresse na organização da sua empresa para colaborar com a equipe. Se sua empresa não tiver uma organização, você pode criar uma.
Ingressar em uma organização existente
1. Solicite um convite
Peça ao administrador da organização que envie um convite a você. Você tem 24 horas para aceitá-lo. Se ele expirar, peça ao administrador que o envie novamente.
2. Aceite o convite
Faça login com sua ID de usuário e senha existentes. Se sua ID estiver associada a outra organização, crie outra.
Criar uma organização
Ao criar uma organização, você recebe automaticamente a função de administrador. Um administrador pode convidar usuários para ingressar na organização, atribuir projetos e funções e gerenciar contas de faturamento.
Para saber mais sobre as funções dos usuários, leia o Guia de administração da organização.
1. Selecione Criar ou ingressar em uma organização na barra de navegação.
2. Insira as informações a seguir:
- Em Trabalho para uma empresa que, selecione Vende ou fornece uma solução de software que usa a tecnologia da FedEx e gostaria de me cadastrar como Fornecedor de integração validado da FedEx.
- Insira o nome e o site da empresa e escolha um nome para a organização que sua equipe reconheça, como o nome da empresa, do departamento, da divisão ou da região.
- Insira um endereço de e-mail oficial que inclua o domínio da empresa, o país ou território onde ela está registrada e os países e territórios onde você vende ou distribui sua solução de software.
3. Clique em Próximo.
Você pode atualizar ou adicionar informações mais tarde em Gerenciar organização no menu.
Adicionar uma conta de faturamento
1. Selecione a guia Contas de faturamento. Se você não tiver uma conta de faturamento da FedEx, selecione Abrir conta de faturamento para criar uma ou entre em contato com o suporte da FedEx.
Observação: use seu próprio número de conta, não o número de conta FedEx de um cliente.
2. Selecione Adicionar conta de faturamento.
3. Insira o número de sua conta FedEx, o apelido da conta e o endereço de cobrança nos Estados Unidos que você usou ao configurar a conta.
Observação: o endereço de cobrança deve corresponder ao endereço que você usou ao configurar a conta, que será a conta de faturamento padrão da organização.
4. Escolha uma opção de autenticação.
- A opção de chamada telefônica só está disponível para integradores nos Estados Unidos e no Canadá.
5. Insira o código de autenticação que você receber e selecione Enviar.
6. Leia e aceite o Contrato de Integrador da FedEx.
Convidar um usuário como administrador
1. Acesse a página Gerenciar organização e selecione Usuários.
2. Selecione + Adicionar usuários.
3. Insira as informações a seguir:
- O país ou território;
- O idioma de preferência.
4. Selecione uma função de usuário (Visualizador, Colaborador ou Administrador).
5. (Opcional) Atribua o usuário a um projeto.
- Você pode atribuir um usuário a qualquer momento na página Visão geral do projeto.
6. Insira os endereços de e-mail dos usuários e clique em Convidar.
- Você pode convidar até 20 usuários de uma vez separando cada e-mail com uma vírgula. O convite expira após 24 horas.
Criar um projeto
1. Acesse a página Meus projetos e selecione + Criar projeto.
2. Insira o Nome do projeto.
- O formato recomendado é Nomedoprojeto_nomedoaplicativo. Quando terminar, clique em Próximo.
3. Selecione as APIs e os produtos de visibilidade integrada avançada para incluir no projeto.
- Os produtos de visibilidade integrada avançada só estão disponíveis para fornecedores de integração da FedEx nos EUA.
- Se você selecionar um produto pago, precisará atribuir uma conta de faturamento ao projeto e aceitar os termos obrigatórios.
Atribuir uma conta de faturamento
Observação: esta etapa só será necessária se você selecionar um produto pago.
1. Escolha a conta de faturamento a ser atribuída na lista das contas adicionadas à organização. É obrigatório que as contas de faturamento sejam estabelecidas nos Estados Unidos.
2. Aceite o Contrato de Licença do FedEx Developer Portal e o formulário de pedido e selecione Criar.
Configurar a visibilidade integrada avançada em um projeto
Pré-requisitos
- Revisão de preços: é cobrada uma taxa mensal dos assinantes com base no total de números de rastreamentos. Consulte o formulário de pedido para saber mais sobre os preços.
- Configuração de contas: o webhook de visibilidade da remessa exige uma conta de faturamento sediada nos EUA e pelo menos uma conta de envio; esses dois tipos de conta são mutuamente exclusivos. Só os administradores podem adicionar contas de faturamento e de envio na página Gerenciar organização.
1. Crie um URL de destino no seu aplicativo ou plataforma para receber chamadas de retorno. O URL precisa:
- usar o protocolo HTTPS;
- excluir o espaço de endereços IP RFC1918, o fedex.com e seus subdomínios, além de endereços IP como localhost ou 127.0.0.1.
2. Gere um token de segurança para autenticação. O token precisa:
- ter de 26 a 100 caracteres, pelo menos uma letra maiúscula, uma letra minúscula e um número.
3. No menu, clique em Meus Projetos e selecione a guia Visibilidade integrada avançada.
4. Selecione Criar um projeto de visibilidade integrada avançada.
5. Selecione o tipo de usuário:
- Remetente FedEx: faz envios com a FedEx e precisa integrar as APIs da FedEx nos próprios aplicativos
- Fornecedor compatível com a FedEx: um fornecedor compatível com a FedEx certificado
- Fornecedor de integração da FedEx: vende ou fornece uma solução de software que usa a tecnologia da FedEx e é um Fornecedor de integração validado da FedEx
6. Selecione o tipo de assinatura. Você pode assinar eventos por número de conta ou número de rastreamento.
7. Confirme a conta de faturamento e selecione os recursos desejados, como comprovante de entrega, entrega estimada, eventos de rastreamento ou filtragem baseada em eventos.
8. Informe os detalhes do projeto.
- Insira um nome de projeto exclusivo e reconhecível.
- Insira o URL de destino e o token de segurança que você criou.
- Insira um endereço de e-mail e o idioma escolhido para receber notificações sobre atualizações e interrupções da visibilidade integrada avançada.
9. Aceite o Contrato de Licença do FedEx Developer Portal e o formulário de pedido e selecione Criar.
Observação: dependendo do tipo de assinatura escolhido, pode haver etapas adicionais. Para obter mais informações, consulte a documentação sobre webhooks.
Siga estas etapas para verificar a integração da API e confirmar que seu aplicativo pode enviar e receber dados de teste.
1. No menu, selecione Meus projetos e o Nome do projeto.
2. Suas credenciais estão na guia Chaves da API, em Chave de teste.
3. Faça login e baixe a coleção JSON API clicando no botão Baixar esquema JSON no topo da página de documentação. Revise as solicitações de exemplo para os endpoints que sua integração usa.
4. Solicite um token de acesso OAuth para usar com todas as transações da API. O token é válido apenas por uma hora, e você pode configurar o aplicativo para atualizar o token antes que ele expire. Para obter mais informações, consulte a documentação da API Authorization.
5. No menu, selecione Catálogo de APIs, escolha a API que deseja usar e selecione Documentação.
6. No menu, selecione o endpoint.
7. Envie solicitações de amostra usando as credenciais de teste e o URL de teste da FedEx. Em seguida, verifique se as respostas correspondem aos exemplos da documentação. Para obter mais informações, consulte o guia Virtualização de sandbox.
8. Faça testes com a visibilidade integrada avançada para gerar dados de amostra e verificar se o aplicativo processa as informações de rastreamento corretamente.
Observação: o teste não autentica o URL de retorno de chamada. Para obter mais informações, consulte a documentação sobre a visibilidade integrada avançada.
Os passos de validação variam conforme a região
As etapas a seguir aplicam-se somente a clientes nos EUA e no Canadá. Se você não morar nesses países, acesse a página Validação de APIs para obter suporte.
Antes de migrar suas APIs para produção, é preciso validá-las. O nível de validação varia conforme a API. Consulte os requisitos de validação da API antes de começar.
1. No menu, selecione Meus projetos e o Nome do projeto.
2. Suas credenciais estão na guia Chaves da API, em Chave de teste.
3. Identifique todos os casos de teste para as regiões ou territórios em que você deseja implantar sua solução. Para obter mais informações, consulte a linha de base de casos de teste do integrador.
4. Conclua as transações de registro usando os números de conta de teste fornecidos antes de executar os casos de teste.
5. Conclua todos os casos de teste necessários.
6. Preencha a ficha de informações do produto (PIW) com suas informações de contato e os serviços da FedEx que você deseja utilizar.
7. Preencha a folha de capa da validação do integrador.
Enviar documentos
Envie todos os materiais necessários para validationmtp@fedex.com.
1. Prepare estes documentos:
- PIW preenchida (PDF)
- Folha de capa da validação preenchida (PDF)
- Transações de registro de cliente final com autenticação multifator (JSON)
- Etiquetas de envio escaneadas para todos os casos de teste aplicáveis (PDF ou PNG)
- Transações de envio em três formatos de etiqueta (PDF, PNG e ZPL [JSON]) para as APIs de envio e cotação aplicáveis
- Capturas de tela (PDF):
- da solução que será fornecida ao cliente mostrando os serviços da FedEx e o manuseio especial;
- da declaração de isenção de responsabilidade;
- do Contrato de Licença de Usuário Final (EULA);
- do fluxo de registro do cliente final.
2. Compacte todos os arquivos em um único arquivo .zip para evitar restrições do provedor de e-mail.
3. Envie o arquivo .zip por e-mail para a equipe de validação.
Práticas recomendadas para evitar atrasos
Siga estas orientações para reduzir o tempo de revisão:
- Imprima e escaneie as etiquetas com no mínimo 600 DPI. Não envie arquivos gerados diretamente das APIs.
- Caso use impressoras térmicas, solicite um tipo de imagem compatível com o modelo da impressora, por exemplo, ZPLII para impressoras Zebra.
- Para o FedEx International Express®, inclua o conhecimento aéreo (AWB) auxiliar (secundário).
- Inclua uma etiqueta para cada pacote nas remessas de vários volumes (MPS).
Avaliação da etiqueta
A equipe de validação revisará os documentos que você enviou.
- Se eles forem rejeitados, faça as alterações solicitadas no feedback e envie os documentos novamente.
- Se eles forem aprovados, você receberá um e-mail de confirmação. Depois disso, suas credenciais de produção serão autorizadas para transações com etiquetas de envio.
1. No menu, selecione Meus projetos e o Nome do projeto.
2. Na seção APIs, copie e salve a chave da API de produção e a chave secreta de produção.
Observação: salve a chave secreta em um local seguro, pois ela só aparece uma vez. Se você a perder, poderá gerar outra.
