Introdução
O FedEx Developer Portal oferece um conjunto de Interfaces de Programação do Aplicativo (APIs) para integrar a FedEx aos seus aplicativos. Estas instruções vão orientar você na configuração de organizações, criação de projetos, teste de integrações, migração de projetos para produção e, em alguns casos, validação de APIs.
Tipos de usuário:
A FedEx oferece serviços de integração para três tipos de usuário: Remetentes da FedEx, soluções de software verificadas conhecidas como Fornecedores compatíveis com a FedEx e Fornecedores de integração validados da FedEx.
Remetente da FedEx:
Empresa que faz envios com a FedEx e precisa integrar as APIs da FedEx nos próprios aplicativos.
Fornecedor de soluções ou serviços:
Uma empresa que precisa se integrar às APIs da FedEx para criar uma solução, aplicativo ou plugin que pode ser vendido e/ou distribuído para uma organização externa que faz envios com a FedEx.
- Fornecedor compatível com a FedEx: empresa verificada com um acordo contratual por meio do Programa de compatibilidade da FedEx.
- Fornecedor de integração da FedEx: empresa validada com um acordo contratual por meio do Programa de Integradores da FedEx.
Selecione a opção abaixo que melhor descreve sua empresa. Não importa o seu tipo de usuário, há uma experiência de primeiros passos disponível para você.
Selecione para começar.
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
Pré-requisito
Você deve ter um ID de usuário FedEx para acessar o FedEx Developer Portal e criar uma organização.
Se sua empresa não tiver uma organização, crie uma. Caso contrário, ingresse em uma organização existente.
Criar uma organização
Na barra de navegação, clique em Criar organização ou ingresse em uma já existente.
Observação: a pessoa que cria uma organização é designada automaticamente como administrador.
Os administradores podem:
convidar usuários;
atribuir funções de usuários (como colaborador e visualizador) e projetos;
gerenciar contas de envio.
Para saber mais sobre essas funções, consulte o Guia de administração da organização.
Como tipo de empresa, selecione "Vende ou fornece uma solução de software que usa a tecnologia da FedEx e é um Fornecedor de integração validado da FedEx".
Informe o nome da empresa e o URL do site e crie um nome exclusivo para a organização. O nome da organização pode ser o nome da empresa ou representar um grupo específico, como um departamento, uma divisão, uma região ou uma localização. Essas informações são necessárias para validar a solicitação.
Observação: dê à sua organização um nome que outros usuários reconheçam, como o nome da empresa, departamento, região, localização.
Especifique a localização da empresa e onde você venderá ou distribuirá sua solução de software.
Adicione uma conta de faturamento e autentique a conta
Observação: como fornecedor de transporte e logística do Programa de Integradores da FedEx, você deve usar o número de sua própria conta. Você não pode usar a conta FedEx de um cliente.
Insira o número de sua conta FedEx. Se não tiver uma conta FedEx, crie uma em fedex.com ou entre em contato com um representante de atendimento da FedEx.
Insira o apelido da conta e o endereço de cobrança associado a ela. Clique em Próximo.
Observação: o endereço de cobrança deve corresponder ao endereço registrado para essa conta, que é a conta de faturamento padrão de sua organização.
Para terminar de criar a organização, você precisa autenticar sua conta. Escolha uma opção de autenticação (como telefone, disponível apenas para integradores nos EUA e CA, e-mail ou mensagem de texto) e clique em Próximo.
Insira o código de autenticação recebido e clique em Enviar.
Aceitar os termos
Leia o Contrato Global e o Manual do Programa de Integradores. Marque as caixas relevantes para confirmar que aceita os termos e, em seguida, clique em Aceitar.
Será mostrada uma tela de confirmação. Clique em Gerenciar organização se precisar editar algum detalhe.
Convidar usuários
Observação: apenas administradores podem convidar usuários.
Selecione Gerenciar organização no menu de navegação à esquerda.
Acesse a guia Usuários e selecione Adicionar usuários.
Preencha o formulário e atribua a função apropriada aos novos usuários: visualizador, colaborador ou administrador.
Para obter mais informações sobre as funções de usuários, consulte o Guia de administração da organização.
Atribua usuários a projetos, se aplicável, no menu suspenso Projetos.
Digite os endereços de e-mail de cada usuário e clique em Convidar.
Ingressar em uma organização existente
Solicite um convite: peça ao administrador da organização que envie um convite a você. Você tem 24 horas para aceitá-lo antes que ele expire. Se necessário, peça ao administrador que o envie novamente.
Aceite o convite: faça login com sua ID de usuário e senha existentes. Se sua ID estiver associada a outra organização, você terá que criar outra ID.
Ingressar em uma organização existente
Etapa 1: peça ao administrador da organização que envie um convite a você
Se a empresa já criou uma organização, peça ao administrador que convide você para participar. Você terá 24 horas para aceitar o convite. Se perder esse intervalo de tempo, poderá solicitar o reenvio.
Etapa 2: aceite o convite
Para aceitar o convite, faça login com sua ID de usuário e senha existentes ou crie outra se a ID existente já estiver associada a uma organização.
Criar um projeto de API
Acesse a página Meus projetos e abra a guia APIs. Clique no botão Criar projeto de API.
Etapa 1: selecione as APIs que deseja incluir no projeto
Revise as cotas da API, os limites de tarifa e os detalhes da validação da API.
Etapa 2: configure os detalhes do projeto
- 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.
Etapa 3: leia e aceite os termos, incluindo o Contrato de Licença do FedEx Developer Portal
Depois de aceitar os termos e clicar no botão Criar, você verá uma tela de confirmação. Você poderá visualizar suas credenciais de teste no novo projeto.
Criar um projeto de webhook
Pré-requisitos
- Analisar preços: é cobrada uma taxa mensal dos assinantes com base na contagem de números de rastreamentos. Consulte o Guia de preços para saber mais sobre preços.
- Configurar contas: o webhook Visibilidade integrada avançada requer uma conta de faturamento baseada nos EUA e pelo menos uma conta de envio; esses dois tipos de conta são mutuamente exclusivos. Apenas administradores podem adicionar contas de faturamento e de envio na página Gerenciar organização.
Criar um URL válido (de retorno) em seu aplicativo ou plataforma de destino
O URL de destino será usado para receber códigos de autenticação e mensagens, bem como notificações de carga útil de webhook da FedEx. O URL deve usar HTTPS para garantir a segurança. O URL será bloqueado se incluir:
- Espaço IP RFC1918
- fedex.com ou qualquer um dos respectivos subdomínios
- Endereços IP no URL (inclusive localhost, 127.0.0.1)
Gerar um token de segurança
É possível usar o token de segurança como uma chave secreta para autenticar e validar as informações transmitidas entre a sua organização e a FedEx. Seu token de segurança deve incluir:
- No mínimo 26 e no máximo 100 caracteres
- Uma letra maiúscula
- Uma letra minúscula
- Um caractere numérico
Exemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Depois de definir o URL e o token de segurança, estará tudo pronto para criar um projeto de webhook. Acesse a página Meus projetos e abra a guia Webhooks. Clique no botão Criar um projeto de webhook.
Selecionar o tipo de assinatura
Os remetentes da FedEx podem associar os eventos a números de conta ou de rastreamento.
Etapa 1: confirme a conta de faturamento e selecione os recursos
- Analise a conta de faturamento padrão listada para confirmar ou selecione uma diferente da sua organização.
- Configure o projeto selecionando recursos como opções de comprovante de entrega, opções de entrega estimada, eventos de rastreamento e filtragem baseada em eventos.
Etapa 2: informe os detalhes do projeto
- Dê ao projeto um nome identificável exclusivo para sua organização.
- Informe o URL de destino e os detalhes do token de segurança que você criou durante a autenticação de pré-configuração (consulte as etapas acima).
- Para receber as atualizações mais recentes do webhook e outras informações relacionadas a interrupções, informe um endereço de e-mail e o idioma de sua preferência.
Etapa 3: leia e aceite os termos
Depois de aceitar os termos, incluindo o Contrato de Licença do FedEx Developer Portal e o Formulário de Pedido, e clicar no botão Criar, você verá uma tela de confirmação.
Pode haver etapas extras, com base na seleção do tipo de assinatura. Acesse a documentação para saber mais.
Na página Visão geral do projeto da API, recupere suas credenciais de teste (chave da API, chave secreta e contas de envio) na guia Chave de teste.
Etapa 1: solicite um token de acesso OAuth
O token de acesso OAuth 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 a documentação da API Authorization para obter mais detalhes.
Etapa 2: revise a documentação da API
Clique na documentação de cada uma das APIs para ler o contexto comercial e entender como usá-las. Faça login para baixar a coleção JSON API por meio do botão no topo da página de documentação. Você também pode revisar solicitações de exemplo para o endpoint que corresponde à integração desejada.
Etapa 3: use o sandbox para testar transações de amostra
Clique no endpoint desejado na navegação à esquerda para acessar o sandbox específico. Identifique as solicitações de exemplo que correspondem ao caso de uso e use suas credenciais de teste e os URLs de teste da FedEx para implementar as chamadas para o endpoint, conforme descrito nas solicitações de exemplo. Verifique se as respostas de chamada da API recebidas correspondem às mostradas na documentação. Saiba mais sobre nossa experiência com testes no Guia de Virtualização de Sandbox.
Testes com webhooks
Os testes podem ajudar você a saber se o URL criado é 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.
Acesse a página Visão geral do projeto e abra a guia Chave de produção. Não é necessário mover para a produção os projetos de assinatura de número da conta de visibilidade integrada avançada.
Etapa 1: configure o projeto
- Renomeie 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.
Etapa 2: obtenha as chaves do projeto
Copie sua chave de API de produção, e a chave secreta de produção será exibida em um local seguro. Para manter a chave secreta de produção segura, ela só aparece uma vez. Se você a perder, poderá gerar outra.
Depois de obter as chaves do projeto e clicar em Avançar, você verá os detalhes do projeto na guia Chave de produção.
- Para adicionar mais contas de envio ao projeto, clique em Editar na parte superior da tabela de contas de envio.
Os passos de validação variam conforme a região
Os seguintes passos aplicam-se somente aos clientes dos EUA e do Canadá. Se você mora fora desses países, visite a página Validação de API para encontrar suporte.
Algumas APIs exigem validação de etiqueta de envio para uso em nosso ambiente de produção. Veja se a sua API requer validação.
Etapa 1. Desenvolva e teste as APIs da FedEx com seu aplicativo habilitado pela web
Depois de concluir o desenvolvimento do aplicativo habilitado para a web, é hora de testá-lo usando as credenciais de teste (dados de teste para contas de envio, chave da API e chave secreta). A chave da API e a chave secreta de teste serão exibidas na página de visão geral do projeto e podem ser vistas a qualquer momento.
Etapa 2: Mova seu projeto para produção
Depois de testar com as APIs da FedEx, você precisa iniciar o processo de validação movendo seu projeto para produção no FedEx Developer Portal. Depois de fazer isso com sucesso, você verá sua chave da API e a chave secreta de produção. Você verá sua chave secreta de produção apenas uma vez, mas poderá regerá-la posteriormente.
Etapa 3: Preencha a folha de capa da etiqueta
Preencha toda a folha de capa da etiqueta com as informações de contato apropriadas e com os serviços que você planeja implementar. Inclua o número da conta e a chave de produção.
Etapa 4: gere e envie etiquetas de teste para o grupo de análise de código de barras
Gere etiquetas de teste no ambiente de teste da FedEx associado ao aplicativo e as envie à(s) equipe(s) de avaliação de etiquetas da FedEx para aprovação. O grupo de análise de código de barras precisa de três dias úteis para responder à avaliação da etiqueta.
Siga estas práticas recomendadas para evitar atrasos no processamento:
- As etiquetas precisam ser impressas e digitalizadas com no mínimo 600 DPI. NÃO ENVIE ARQUIVOS GERADOS DE APIs.
- Caso use impressoras térmicas, o tipo de imagem da etiqueta precisa ser solicitado de acordo com o modelo da impressora. Exemplo: ZPLII para impressoras Zebra.
- Use as informações de endereço do remetente/destinatário ao criar etiquetas de amostra para avaliação. Só crie etiquetas de amostra para os serviços específicos sendo solicitados.
- A etiqueta de cobrança na entrega (COD) FedEx® também precisa incluir a etiqueta de devolução da COD correspondente.
- As remessas FedEx International Express® também precisam incluir a etiqueta auxiliar/secundária do conhecimento aéreo (AWB).
- As remessas de vários volumes (MPS) devem incluir uma etiqueta para cada pacote na remessa.
- Envie o PDF e a folha de capa da etiqueta por e-mail para label@fedex.com.
- Etiquetas físicas podem ser enviadas para o endereço abaixo:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Se as etiquetas digitalizadas não apresentarem defeitos visíveis (como linhas passando pelo código de barras, manchas de tinta ou danos físicos), elas passarão por inspeção e a aprovação será concedida.
Ao enviar etiquetas físicas, observe a qualidade da impressão e a expansão/contração acidental das etiquetas (ou seja, a escala). Esses são os dois principais motivos da reprovação de etiquetas no processo de avaliação.
Etapa 5: revise a avaliação da etiqueta
O grupo de análise de código de barras avaliará as etiquetas de teste enviadas e aprovará ou rejeitará essas etiquetas. O grupo da análise de código de barras entrará em contato com você sobre a aprovação ou rejeição das etiquetas enviadas. Se as etiquetas forem aprovadas, continue na próxima etapa. Se as etiquetas forem rejeitadas, corrija-as conforme as instruções e reenvie-as para aprovação.
Etapa 6: habilite o aplicativo
Assim que as etiquetas de teste forem aprovadas para status de produção pelo grupo de análise de código de barras, ele autorizará suas credenciais de produção a transmitir a transação de etiqueta de envio identificada e notificará você por e-mail sobre a validação bem-sucedida. A aprovação é feita por projeto.
Etapa 7: Substitua o URL e as credenciais
Substitua o URL de teste e as credenciais de teste pelo URL de produção e pelas credenciais de produção. Teste novamente sua implementação no ambiente de produção usando os dados de amostra.
Pré-requisito
Sua empresa deve ser um fornecedor compatível com a FedEx já existente. Se sua empresa não faz parte do programa de Compatibilidade, altere sua seleção acima para “Provedor não compatível”.
Etapa 1: receba o convite para ingressar na organizaçã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.
Etapa 2: aceite o convite
Para aceitar o convite, faça login com sua ID de usuário e senha existentes ou crie outra se a ID existente já estiver associada a uma organização.
Etapa 3: convide usuários
Um administrador pode convidar usuários para a organização e atribuir funções e projetos a eles. Abra a guia Usuários. Clique no botão Adicionar usuários.
- Selecione uma função de usuário: Visualizador, Colaborador ou Administrador. Saiba mais sobre funções em nosso Guia de Administração da Organização.
- Se houver projetos existentes, atribua um ao usuário. Você também pode atribuir usuários a projetos em qualquer página de visão geral do projeto.
- Informe os endereços de e-mail dos usuários que você deseja que ingressem na sua organização na função selecionada.
Acesse o Catálogo de APIs para determinar as APIs ou os webhooks corretos 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.
Etapa 1: preencha a PIW
Retorne à Comunidade de Fornecedores Compatíveis (CPC) para preencher a Ficha de Informações do Produto (PIW).
Etapa 2: revise o(s) projeto(s) criados pela FedEx
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.
Etapa 3: participe da demonstração da API com sua equipe
A equipe de compatibilidade da FedEx, juntamente com as equipes de CTC e verificação da FedEx, organizarão uma demonstração técnica das APIs com sua equipe. A equipe da FedEx discutirá a verificação de programas compatíveis, novos recursos e funcionalidades da API e responderá a perguntas.
Na página Visão geral do projeto da API, recupere suas credenciais de teste (chave da API e chave secreta) na guia Chave de teste.
Etapa 1: crie chaves de cliente
Use a API de registro de credenciais para criar chaves de cliente. Esta é uma API privada encontrada somente na seção API na parte inferior da página Visão geral do projeto da API.
Etapa 2: solicite um token de acesso OAuth
O token de acesso OAuth 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 a documentação da API Authorization para obter mais detalhes. Ao visualizar o código de amostra, escolha “Revendedor” no menu suspenso de amostras.
Etapa 3: revise a documentação da API
Clique na documentação de cada uma das APIs para ler o contexto comercial e entender como usá-las. Faça login para baixar a coleção JSON API por meio do botão no topo da página de documentação. Você também pode revisar solicitações de exemplo para o endpoint que corresponde à integração desejada.
Etapa 4: use o sandbox para testar transações de amostra
Clique no endpoint desejado na navegação à esquerda para acessar o sandbox específico. Identifique as solicitações de exemplo que correspondem ao caso de uso e use suas credenciais de teste e os URLs de teste da FedEx para implementar as chamadas para o endpoint, conforme descrito nas solicitações de exemplo. Verifique se as respostas de chamada da API recebidas correspondem às mostradas na documentação. Saiba mais sobre nossa experiência com testes no Guia de Virtualização de Sandbox.
Etapa 5: verifique cada solução
Depois de testar completamente suas soluções, envie casos de teste para a equipe de verificação conferir cada solução. A FedEx revisará tudo que foi enviado e atualizará você quando sua verificação for aprovada.
Testes com webhooks
Se a sua organização tiver acesso a webhooks, os testes poderão ajudar você a ter uma ideia melhor se o URL criado é 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.
Em seguida, a FedEx moverá seu(s) projeto(s) para a produção. Acesse a página de Visão geral do seu projeto de API e abra a guia Chave de produção. Clique no link Gerar chave secreta na coluna Chave secreta.
Assim, você poderá testar novamente sua implementação no ambiente de produção usando os dados de amostra.
Pré-requisito
Você deve ter um ID de usuário e uma conta FedEx para acessar o FedEx Developer Portal e criar uma organização.
Crie uma organização, se ainda não existir na sua empresa, ou participe da organização que já existe.
Criar uma organização
Na barra de navegação, clique em Criar organização ou ingresse em uma já existente.
Observação: a pessoa que cria uma organização é designada automaticamente como administrador.
Os administradores podem:
convidar usuários;
atribuir funções de usuários (como colaborador e visualizador) e projetos;
gerenciar contas de envio.
Para saber mais sobre essas funções, consulte o Guia de administração da organização.
Como tipo de empresa, selecione "Vende ou fornece uma solução de software que usa a tecnologia da FedEx e é um Fornecedor de integração validado da FedEx".
Informe o nome da empresa e o URL do site e crie um nome exclusivo para a organização. O nome da organização pode ser o nome da empresa ou representar um grupo específico, como um departamento, uma divisão, uma região ou uma localização. Essas informações são necessárias para validar a solicitação.
Observação: dê à sua organização um nome que outros usuários reconheçam, como o nome da empresa, departamento, região, localização.
Especifique a localização da empresa e onde você venderá ou distribuirá sua solução de software.
Adicione uma conta de faturamento e autentique a conta
Observação: como fornecedor de transporte e logística do Programa de Integradores da FedEx, você deve usar o número de sua própria conta. Você não pode usar a conta FedEx de um cliente.
Insira o número de sua conta FedEx. Se não tiver uma conta FedEx, crie uma em fedex.com ou entre em contato com um representante de atendimento da FedEx.
Insira o apelido da conta e o endereço de cobrança associado a ela. Clique em Próximo.
Observação: o endereço de cobrança deve corresponder ao endereço registrado para essa conta, que é a conta de faturamento padrão de sua organização.
Para terminar de criar a organização, você precisa autenticar sua conta. Escolha uma opção de autenticação (como telefone, disponível apenas para integradores nos EUA e CA, e-mail ou mensagem de texto) e clique em Próximo.
Insira o código de autenticação recebido e clique em Enviar.
Aceitar os termos
Leia o Contrato e o Manual do Programa de Integradores da FedEx. Marque as caixas relevantes para confirmar que aceita os termos e, em seguida, clique em Aceitar.
Será mostrada uma tela de confirmação. Clique em Gerenciar organização se precisar editar algum detalhe.
Convidar usuários
Observação: apenas administradores podem convidar usuários.
Selecione Gerenciar organização no menu de navegação à esquerda.
Acesse a guia Usuários e selecione Adicionar usuários.
Preencha o formulário e atribua a função apropriada aos novos usuários: visualizador, colaborador ou administrador.
Para obter mais informações sobre as funções de usuários, consulte o Guia de administração da organização.
Atribua usuários a projetos, se aplicável, no menu suspenso Projetos.
Digite os endereços de e-mail de cada usuário e clique em Convidar.
Ingressar em uma organização existente
Solicite um convite: peça ao administrador da organização que envie um convite a você. Você tem 24 horas para aceitá-lo antes que ele expire. Se necessário, peça ao administrador que o envie novamente.
Aceite o convite: faça login com sua ID de usuário e senha existentes. Se sua ID estiver associada a outra organização, você terá que criar outra ID.
Criar um projeto de API
Acesse a página Meus projetos e selecione Criar projeto.
Preencha o campo Nome do projeto. O formato recomendado é "Nomedoprojeto_nomedoaplicativo". Quando terminar, clique em Próximo.
Selecione a API e os produtos de visibilidade integrada avançada para o projeto.
Observação: os produtos de visibilidade integrada avançada só estão disponíveis para fornecedores de integração da FedEx nos EUA.
Observação: se você selecionar um produto pago, precisará atribuir uma conta de faturamento ao projeto e aceitar os termos necessários.
Atribuir a conta de faturamento e aceitar os termos
Escolha uma conta de faturamento na lista de contas adicionadas à organização. Esta etapa só será necessária se você tiver selecionado um produto pago.
Aceite os termos e condições associados ao produto.
Confirmar detalhes
Revise os produtos selecionados. Verifique a conta de faturamento informada.
Leia e aceite o Contrato de Licença do FedEx Developer Portal.
Clique em Criar para gerar o projeto e visualizar suas credenciais de teste.
Configurar a visibilidade integrada avançada em um projeto
Pré-requisitos
Pré-requisitos
- Revisar os preços: é cobrada uma taxa mensal dos assinantes com base na contagem de números de rastreamentos. Consulte o formulário de pedido para saber mais sobre preços.
- Configurar contas: o recurso Visibilidade integrada avançada requer uma conta de faturamento baseada nos EUA e pelo menos uma conta de envio; esses dois tipos de conta são mutuamente exclusivos. Apenas administradores podem adicionar contas de faturamento e de envio na página Gerenciar organização.
Criar um URL de retorno de chamada válido no aplicativo ou na plataforma de destino – URL do aplicativo/plataforma:
Por motivos de segurança, é necessário usar HTTPS.
Não inclua o espaço de endereços IP RFC1918, subdomínios fedex.com ou endereços IP diretos (por exemplo, 127.0.0.1).
Gerar um token de segurança
Deve ter entre 26 e 100 caracteres e incluir:
- Uma letra maiúscula
- Uma letra minúscula
- Um número
Exemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Configurar a visibilidade integrada avançada
Escolha a opção de visibilidade integrada avançada. Selecione os recursos desejados, como comprovante de entrega, entrega estimada, eventos de rastreamento e filtragem baseada em eventos.
Insira o URL de destino e o token de segurança.
Forneça um e-mail para receber atualizações e notificações de interrupção da visibilidade integrada avançada.
Confirmar detalhes
Leia e aceite o Contrato de Licença do FedEx Developer Portal e o formulário de pedido.
Selecione Criar para concluir a configuração.
Observação: pode haver etapas adicionais com base no tipo de assinatura. Consulte a documentação para saber mais.
Recuperar credenciais de teste e iniciar o teste
Revise a documentação da API
- Leia a documentação da API para entender as APIs que oferecemos, assim como o contexto comercial e os processos de integração de cada API.
- Baixe o esquema JSON na página de documentação da API relevante.
- Revise os exemplos de solicitação para os endpoints desejados.
Obtenha as credenciais de teste
Na página Visão geral do projeto, vá para a guia Chaves de API. A chave da API e a chave secreta estão listadas no cabeçalho Chave de teste.
Revise a documentação da API
- É necessário um token OAuth para todas as transações da API. O token expira depois de uma hora.
- Seu aplicativo deve atualizar o token antes que ele expire.
- Consulte a documentação da API Authorization para obter mais informações.
Teste as transações da API no sandbox
- Vá para a API relevante no Catálogo de APIs e clique em Documentação.
- Selecione o endpoint de API desejado no menu à esquerda.
- Use os exemplos de solicitação que correspondem a seu caso de uso.
- Implemente as chamadas de API usando suas credenciais de teste e os URLs de teste da FedEx.
- Verifique as respostas com base na documentação.
- Consulte o Guia de virtualização de sandbox para obter mais informações.
Testar a visibilidade integrada avançada
O teste da visibilidade integrada avançada valida o formato do URL e ajuda a estabelecer uma conexão entre a FedEx e seu aplicativo.
O teste fornece dados de teste de amostra para o processamento de informações de rastreamento.
Observação: o teste não autentica seu URL.
Acesse a Documentação sobre a visibilidade integrada avançada para saber mais.
É necessário realizar uma validação para mover as APIs para a produção. O nível de validação varia conforme a API.
Desenvolver e testar APIs da FedEx
- Use as suas credenciais de teste (chave da API e chave secreta) indicadas na página Visão geral do projeto.
- Identifique casos de teste para as regiões/territórios em que você deseja implantar a solução (consulte a linha de base do caso de teste do integrador).
- Antes de executar os casos de teste, conclua as transações de registro usando os números de conta de teste disponibilizados.
- Execute todos os casos de teste necessários.
Acesse a página Visão geral do projeto.
Selecione Solicitar chaves de produção. A FedEx receberá sua solicitação de chaves de produção e enviará uma notificação para você assim que elas forem aprovadas.
Preencher a PIW e a capa da validação
Preencha a ficha de informações do produto (PIW) e a capa da validação do integrador com suas informações de contato e os serviços da FedEx que você pretende utilizar.
Enviar documentos
Reúna os documentos abaixo e compacte-os em um arquivo .zip para evitar restrições do provedor de e-mail. Envie o arquivo compactado para validationmtp@fedex.com.
Documentos necessários
- PIW preenchida (PDF)
- Capa da validação preenchida (PDF)
Capturas de tela (PDF):
Solução que será fornecida ao cliente mostrando os serviços da FedEx/manuseio especial
Declaração de isenção de responsabilidade
Contrato de licença de usuário final
Fluxo de registro do cliente final
- 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/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)
Práticas recomendadas para evitar atrasos
- As etiquetas precisam ser impressas e escaneadas com no mínimo 600 DPI.
- Etiquetas impressas com impressoras térmicas devem corresponder ao modelo da impressora, como ZPLII para impressoras Zebra.
- As remessas FedEx International Express® também precisam incluir uma etiqueta auxiliar do conhecimento aéreo (AWB).
- As remessas de vários volumes (MPS) precisam incluir uma etiqueta para cada pacote.
Avaliação da etiqueta
A equipe de validação aprovará ou rejeitará a etiqueta enviada.
- Se ela for rejeitada, faça as correções e envie-a novamente com base nos comentários recebidos.
- Se ela for aprovada, você receberá um e-mail confirmando a validação. Depois disso, suas credenciais de produção serão autorizadas para transações com etiquetas de envio.
Instruções de pós-validação
Leia e implemente os requisitos pós-validação conforme necessário.
Assim que receber uma notificação de que as chaves de produção foram aprovadas, recupere-as na guia Visão geral do projeto.
- Copie e salve a chave da API de produção e a chave secreta de produção em um local seguro.
- A chave secreta é mostrada somente uma vez. Em caso de perda, será necessário gerar uma chave nova.
