Remetente da FedEx | FedEx Developer Portal

1 Criar ou ingressar em 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 envio.

Para saber mais sobre as funções dos usuários, leia o Guia de administração da organização.

1. Faça login no FedEx Developer Portal.

2. No menu, selecione Meus projetos e Criar organização.

3. Insira as informações a seguir:

Em Trabalho em uma empresa que, selecione faz envios com a FedEx e precisa integrar as APIs da FedEx nos próprios aplicativos.
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.

4. Selecione Criar.

Você pode atualizar ou adicionar informações mais tarde em Gerenciar organização no menu.

Adicionar uma conta de envio

1. Selecione Adicionar contas de envio no título Adicionar contas. Se você não tiver uma conta FedEx, selecione Criar conta ou entre em contato com a equipe de suporte da FedEx.

2. Selecione + Adicionar conta.

3. Insira o número de sua conta FedEx, o apelido da conta e o endereço de cobrança que você usou ao configurar a conta.

4. Aceite o Contrato de Licença de Usuário Final ou encaminhe-o para um representante autorizado da sua empresa.

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.

2. Selecione Adicionar conta de faturamento. É obrigatório que as contas de faturamento sejam estabelecidas nos Estados Unidos.

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.

4. Leia e aceite o Contrato de Licença de Usuário Final.

Convidar um usuário como administrador

1. No menu, selecione Gerenciar organização e clique em Usuários .

2. Selecione + Adicionar usuários.

3. Selecione um país ou território e o idioma de sua preferência. Depois, escolha uma função de usuário: visualizador, colaborador ou administrador.

4. (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.

5. 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. Os convites expiram após 24 horas.

Crie uma organização

2 Criar um projeto

Criar um projeto de API

1. No menu, selecione Meus projetos, clique na guia APIs e escolha + Criar projeto de API.

2. Confirme suas necessidades de API.

3. Selecione as APIs que deseja incluir no projeto.

4. Crie um nome para o projeto e selecione os países para os quais pretende enviar remessas para receber uma conta teste de envio. Para remessas domésticas na Europa, é necessário ter uma conta teste separada para cada país. Você pode adicionar ou remover países mais tarde.

5. Selecione Configurações em Notificações para definir suas preferências de notificação.

6. Leia e aceite os termos e condições.

Criar um projeto de visibilidade integrada avançada

Pré-requisitos

Revisão de preços: é cobrada uma taxa mensal dos assinantes com base no total de números de rastreamentos. Consulte o Guia de preços 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. Insira 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.

ACESSAR MEUS PROJETOS

3 Testar a integração

Siga estas etapas para verificar a integração da API e confirmar que seu aplicativo pode enviar e receber dados de teste.

Recuperar credenciais 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.

Observação: 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.

4 Migrar para a produção

Mover o projeto para a produção

Defina sua configuração de produção antes a implementação. Você pode renomear a chave, adicionar contas depois que o projeto for implementado e revisar o número de conta selecionado no momento da criação do projeto. O número de conta é usado para migrar o projeto para a produção.

Observação: assinaturas da visibilidade integrada avançada baseadas em número de conta não exigem a ativação da produção.

1. No menu, selecione Meus projetos e o Nome do projeto.

2. Selecione a guia Chave de produção.

3. Recupere e salve as credenciais de produção.

Copie a chave da API de produção e a chave secreta em um local seguro.
Quando você solicitar uma chave de produção, salve-a em um local seguro, pois ela aparece apenas uma vez. Se você a perder, poderá gerar outra.

4. Selecione Próximo para visualizar as informações do projeto na guia Chave de produção.

Para adicionar mais contas de envio, clique em Editar na parte superior da tabela de contas de envio.

5 Validar a API

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.

Validar a API

Algumas APIs da FedEx exigem validação da etiqueta de envio antes do uso na produção. 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. Depois de concluir o teste, mova o projeto para a produção no FedEx Developer Portal para iniciar a validação.

Quando você solicitar uma chave de produção, salve-a em um local seguro, pois ela aparece apenas uma vez. Se você a perder, poderá gerar outra.

4. Insira as informações necessárias na folha de capa da etiqueta, incluindo informações de contato, serviços que você pretende implementar, número de conta e chave da API de produção.

5. Crie etiquetas de teste no ambiente de teste da FedEx e envie-as ao grupo de análise de código de barras da FedEx para revisão. Aguarde até três dias úteis para a avaliação da etiqueta.

Práticas recomendadas para evitar atrasos:

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.
Use endereços válidos de remetente e destinatário para etiquetas de amostra. Crie etiquetas apenas para os serviços que pretende usar.
Para cobrança na entrega (COD) da FedEx, inclua a etiqueta de devolução COD.
Para o FedEx International Express®, inclua o conhecimento aéreo (AWB) auxiliar (secundário).
Para remessas de vários volumes (MPS), envie uma etiqueta para cada pacote.

Envie os documentos usando uma destas opções:

Envie o PDF e a folha de capa da etiqueta por e-mail para label@fedex.com
Envie as etiquetas físicas para:

FedEx Services

WTC-Business Solutions Testing

10 FedEx Parkway

2nd Floor Horizontal

Collierville, TN 38017

Observação: no caso de etiquetas físicas, verifique se não há defeitos visíveis, como borrões de tinta ou danos. Não amplie nem diminua as etiquetas durante a impressão.

6. O grupo de análise de código de barras da FedEx avaliará o seu envio e aprovará ou rejeitará as etiquetas. Se elas forem rejeitadas, faça as alterações solicitadas no feedback e envie-as novamente.

7. Após a aprovação, o grupo de análise de código de barras da FedEx enviará um e-mail para autorizar as credenciais de produção para transações com etiquetas de envio.

Observação: a aprovação é feita por projeto. É necessário obter autorização para cada projeto novo.

8. Substitua o URL e as credenciais de teste pelo URL e pelas credenciais de produção.

9. Execute um teste de produção final com os dados de amostra para verificar se tudo está funcionando como esperado.