Expedidor FedEx | FedEx Developer Portal

1 Criar ou juntar-se a uma organização

Junte-se à organização da sua empresa para colaborar com a sua equipa. Se a sua empresa não tiver uma organização, pode criar uma.

Juntar-se a uma organização existente

1. Peça um convite

Peça ao administrador da sua organização que lhe envie um convite. Tem 24 horas para o aceitar. Se o convite expirar, peça ao administrador para o reenviar.

2. Aceite o convite

Inicie sessão com a ID de utilizador e a palavra-passe existentes. Se a sua ID de utilizador estiver associada a outra organização, crie uma nova.

Criar uma nova organização

Quando cria uma organização, obtém o cargo de administrador. Com o cargo de administrador, pode convidar utilizadores a juntarem-se à organização, atribuir-lhes funções de utilizador e projetos e gerir contas de expedição.

Para saber mais sobre as funções de utilizador, veja as Orientações de administração da organização.

1. Inicie sessão no FedEx Developer Portal.

2. No menu, selecione Os meus projetos e, em seguida, selecione Criar uma organização.

3. Introduza os seguintes detalhes:

Para Trabalho para uma empresa que, selecione Envia com a FedEx e precisa de integrar as API FedEx nas respetivas aplicações
Introduza o nome da sua empresa, o site da empresa e um nome de organização que a sua equipa reconheça, como o nome da empresa, departamento, divisão ou região.

4. Selecione Criar.

Pode atualizar ou adicionar detalhes posteriormente em Gerir organização no menu.

Adicionar uma conta de expedição

1. Selecione Adicionar contas de expedição no mosaico Adicionar contas. Se não tiver uma conta FedEx, selecione Criar uma conta para abrir uma nova ou contacte o Apoio ao cliente FedEx.

2. Selecione + Adicionar conta.

3. Introduza o seu número de conta FedEx, uma alcunha da conta e o endereço de faturação que utilizou durante a configuração da conta.

4. Aceite o Contrato de Licença de Utilizador Final ou encaminhe-o para um representante autorizado na sua empresa.

Adicionar uma conta de faturação

1. Selecione o separador Contas de faturação. Se não tiver uma conta de faturação FedEx, selecione Abrir conta de faturação para abrir uma nova ou contacte o Apoio ao cliente FedEx.

2. Selecione Adicionar conta de faturação. As contas de faturação têm de estar localizadas nos Estados Unidos.

3. Introduza o seu número de conta FedEx, uma alcunha da conta e o endereço de faturação dos Estados Unidos que utilizou durante a configuração da conta.

4. Leia e aceite o Contrato de Licença de Utilizador Final.

Convidar os utilizadores como administrador

1. No menu, selecione Gerir organização e, em seguida, selecione o separador Utilizadores.

2. Selecione + Adicionar utilizadores.

3. Selecione um país ou território e um idioma preferencial. Em seguida, selecione uma função de utilizador: visualizador, contribuidor ou administrador.

4. (Opcional) Atribua o utilizador a um projeto. Pode atribuir utilizadores em qualquer altura a partir da página Descrição geral do projeto.

5. Introduza os endereços de e-mail dos utilizadores e clique em Convidar. Pode convidar até 20 utilizadores de uma só vez, com cada e-mail separado por uma vírgula. Os convites expiram após 24 horas.

Criar uma Organização

2 Criar um projeto

Criar um projeto de API

1. No menu, selecione Os meus projetos, depois selecione o separador API e escolha + Criar projeto de API.

2. Confirme as suas necessidades de API.

3. Selecione as API a incluir no seu projeto.

4. Crie um nome de projeto e selecione os países para os quais planeia enviar, para receber uma conta de expedição de teste. Para expedições nacionais na Europa, precisa de uma conta de teste separada para cada país. Pode adicionar ou remover países mais tarde.

5. Selecione Definições em Notificações para configurar as 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

Análise de preços: é cobrada uma taxa mensal aos subscritores com base na contagem de números de rastreio. Consulte o Guia de preços para saber mais sobre os preços.
Configurar contas: o webhook de visibilidade da expedição requer uma conta de faturação localizada nos EUA e, pelo menos, uma conta de expedição. Estes dois tipos de conta são mutuamente exclusivos. Apenas os administradores podem adicionar contas de faturação e expedição na página Gerir organização.

1. Crie um URL de destino na sua aplicação ou plataforma para receber redirecionamentos. O URL tem de:

Utilizar HTTPS
Excluir o espaço de IP RFC1918, fedex.com e respetivos subdomínios e endereços IP como localhost ou 127.0.0.1

2. Gere um token de segurança para autenticação. O token tem de:

Conter entre 26 e 100 carateres, pelo menos uma letra maiúscula, uma letra minúscula e um número

3. No menu, Os meus projetos, selecione o separador Visibilidade integrada avançada.

4. Selecione Criar um projeto de Visibilidade integrada avançada.

5. Selecione o tipo de utilizador.

Expedidor FedEx: envia com a FedEx e tem de integrar as API FedEx nas suas próprias aplicações
Fornecedor compatível FedEx: é um Fornecedor compatível FedEx certificado
Fornecedor integrador FedEx: vende ou fornece uma solução de software que utiliza a tecnologia FedEx e é um Fornecedor integrador FedEx validado

6. Selecione o tipo de subscrição. Pode subscrever eventos através de números de conta ou números de rastreio.

7. Confirme a conta de faturação e selecione as funcionalidades que pretende, como a prova de entrega, entrega estimada, eventos de rastreio ou filtragem baseada em eventos.

8. Introduza os detalhes do projeto.

Introduza um nome único e reconhecível para o projeto.
Introduza o URL de destino e o token de segurança que criou.
Introduza um endereço de e-mail e o idioma preferencial para receber notificações sobre atualizações e interrupções da Visibilidade integrada avançada.

9. Aceite o Contrato de licença e o Formulário de pedido do FedEx Developer Portal e selecione Criar.

Nota: consoante o tipo de subscrição escolhido, poderá haver passos adicionais. Para obter mais informações, consulte a nossa documentação sobre webhooks.

IR PARA OS MEUS PROJETOS

3 Testar a sua integração

Siga estes passos para verificar a integração da API e confirmar se a aplicação pode enviar e receber dados de teste.

Obter as credenciais de teste

1. No menu, selecione Os meus projetos e, em seguida, selecione o Nome do projeto.

2. No separador Chaves de API, em Chave de teste, encontre as suas credenciais de teste.

3. Inicie sessão e transfira a coleção da JSON API ao utilizar o botão Transferir JSON no topo da página de documentação. Reveja os pedidos de exemplo para os pontos finais que a sua integração utiliza.

4. Solicite um token de acesso OAuth para utilizar com todas as transações da API.

Nota: o token é válido por uma hora e pode configurar a sua aplicação para atualizá-lo antes que expire. Para mais detalhes, consulte a documentação da API Authorization.

5. No menu, selecione Catálogo de API, escolha a API com a qual pretende trabalhar e selecione Documentação.

6. No menu, selecione o ponto final.

7. Envie pedidos de exemplo com as suas credenciais de teste e o URL de teste da FedEx. Em seguida, confirme se as respostas correspondem aos exemplos da documentação. Para obter detalhes, consulte o Guia de virtualização da sandbox.

8. Execute testes com a Visibilidade integrada avançada para gerar dados de amostra e confirmar que a aplicação processa as informações de rastreio corretamente.

Nota: os testes não autenticam o seu URL de redirecionamento. Para mais detalhes, consulte a documentação de Visibilidade integrada avançada.

4 Passagem para a fase de produção

Passagem do projeto para a fase de produção

Configure a sua configuração de produção antes de publicar. Pode mudar o nome da chave, adicionar contas adicionais após o projeto ser publicado e rever o número de conta selecionado durante a criação do projeto. Este número de conta move o seu projeto para a fase de produção.

Nota: os projetos de Visibilidade integrada avançada baseados no número de conta não requerem ativação de produção.

1. No menu, selecione Os meus projetos e, em seguida, selecione o Nome do projeto.

2. Selecione o separador Chave de produção.

3. Obtenha e armazene as suas credenciais de produção em segurança.

Copie a chave da API de produção e a chave secreta para um local seguro.
Quando solicitar uma chave de produção, guarde-a num local seguro, pois só aparece uma vez. Se a perder, pode gerar uma nova mais tarde.

4. Selecione Seguinte para ver os detalhes do seu projeto no separador Chave de produção.

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

5 Validar a sua API

Validar a sua API

Algumas API da FedEx exigem a validação da etiqueta de expedição antes de poder utilizá-las em produção. Reveja os requisitos de validação da API antes de começar.

1. No menu, selecione Os meus projetos e, em seguida, selecione o Nome do projeto.

2. No separador Chaves de API, em Chave de Teste, encontre as suas credenciais de teste.

3. Após a conclusão do teste, avance com o seu projeto para a fase de produção no FedEx Developer Portal para iniciar a validação.

Quando solicitar uma chave de produção, guarde-a num local seguro, pois só aparece uma vez. Se a perder, pode gerar uma nova mais tarde.

4. Forneça as informações necessárias na Folha de registo de etiquetas, incluindo os detalhes de contacto, os serviços que planeia implementar, o número de conta e a chave da API de produção.

5. Crie etiquetas de teste no ambiente de teste FedEx e, em seguida, envie-as para o Grupo de análise de códigos de barras FedEx para revisão. Aguarde três dias úteis para a avaliação das etiquetas.

Boas práticas para evitar atrasos:

Imprima e leia etiquetas com um mínimo de 600 DPI. Não envie ficheiros gerados diretamente a partir das API.
Para impressoras térmicas, peça o tipo de imagem que corresponde à sua impressora, por exemplo, ZPLII para impressoras Zebra.
Utilize endereços válidos de expedidor e destinatário para as etiquetas de amostra. Crie etiquetas apenas para os serviços que planeia utilizar.
Para Pagamento contra entrega (C.O.D.) da FedEx, inclua a etiqueta de devolução de C.O.D.
Para FedEx International Express®, inclua a Carta de porte (AWB) auxiliar (secundária).
Para expedições multipeças (MPS), envie uma etiqueta por cada volume.

Envie os seus materiais através de uma das seguintes opções:

Envie o PDF e a Folha de registo de etiquetas por e-mail para label@fedex.com.
Envie etiquetas físicas para:

FedEx Services

WTC-Business Solutions Testing

10 FedEx Parkway

2nd Floor Horizontal

Collierville, TN 38017

Nota: nas etiquetas físicas, certifique-se de que não existem defeitos visíveis, como linhas de tinta ou danos. Não aumente nem reduza as etiquetas durante a impressão.

6. O Grupo de análise de códigos de barras FedEx analisa o seu envio e aprova ou rejeita as etiquetas. Se as etiquetas forem rejeitadas, corrija de acordo com o feedback e envie-as novamente.

7. Após aprovação, o Grupo de análise de códigos de barras FedEx envia-lhe um e-mail com a autorização das suas credenciais de produção para transações de etiquetas de expedição.

Nota: a aprovação aplica-se por projeto. Cada novo projeto requer aprovação.

8. Substitua os URL e as credenciais de teste pelos URL e credenciais de produção.

9. Execute um teste final de produção com dados de amostra para confirmar que tudo funciona conforme esperado.