Introdução
O FedEx Developer Portal fornece um conjunto de Interfaces para programação de aplicações (API) para integrar a FedEx nas suas aplicações. Estas instruções ajudam a configurar uma organização, criar um projeto, testar a sua integração, mover um projeto para a fase de produção e, em alguns casos, validar a sua API.
Tipos de utilizadores:
A FedEx disponibiliza serviços de integração a três tipos de utilizadores: expedidores FedEx, soluções de software verificadas (conhecidas como Fornecedores compatíveis FedEx) e fornecedores integradores FedEx validados.
Expedidor FedEx:
Empresa que envia com a FedEx e precisa de integrar as API FedEx nas suas aplicações.
Solução ou Fornecedor de serviços:
Empresa que precisa de integrar as API FedEx para criar uma solução, aplicação ou plugin que pode ser vendido e/ou distribuído a uma organização externa que faz envios com a FedEx.
- Fornecedor compatível FedEx: empresa verificada com um acordo contratual através do Programa de compatibilidade FedEx.
- Fornecedor integrador FedEx: empresa validada com um acordo contratual através do Programa de Integradores FedEx.
Selecione a opção abaixo que melhor descreve a sua empresa. Seja qual for o seu tipo de utilizador, existe uma experiência de introdução disponível para si.
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
Tem de ter um ID de utilizador FedEx para iniciar sessão no FedEx Developer Portal e criar uma organização.
Se a sua empresa não tiver uma organização, crie uma. Em alternativa, junte-se a uma organização existente.
Criar uma nova organização
Na barra de navegação, clique em Criar ou juntar-se a uma organização.
Nota: enquanto criador, é automaticamente designado como administrador da organização.
Os administradores podem:
Convidar utilizadores a juntarem-se.
Atribuir funções (por exemplo: contribuidor, visualizador) e projetos aos utilizadores.
Gerir contas de expedição.
Para saber mais sobre estas funções, consulte o nosso Guia de Administração da Organização.
Para o tipo de empresa, selecione "Vende ou fornece uma solução de software que utiliza a tecnologia FedEx e é um Fornecedor Integrador FedEx validado".
Forneça o nome da sua empresa, o URL do site e um nome da organização único. O nome da organização pode ser igual ao nome da sua empresa ou representar um grupo específico (departamento, divisão, região, localização). Esta informação é necessária para validar o seu pedido.
Nota: escolha um nome da organização que todos os outros utilizadores reconheçam (por exemplo: nome da empresa, departamento, região, localização).
Especifique a localização da sua empresa, bem como o local onde a sua solução de software será vendida ou no qual será distribuída.
Adicione a conta de faturação e autentique-a.
Nota: enquanto fornecedor de expedição e logística no Programa de Integradores FedEx, tem de utilizar o número da sua conta. Não pode utilizar o número da conta FedEx de um cliente.
Introduza o número da sua conta FedEx. Se não tiver uma conta FedEx, crie uma em fedex.com ou contacte um representante do Apoio FedEx.
Introduza uma alcunha da conta e o endereço de faturação associado à conta. Selecione Seguinte.
Nota: o endereço de faturação tem de corresponder aos nossos registos para esta conta. Esta será a conta de faturação predefinida da sua organização.
Para concluir a criação da sua organização, tem de autenticar a sua conta. Escolha uma opção de autenticação (telemóvel disponível apenas para Integradores nos EUA e no Canadá, e-mail ou SMS) e selecione Seguinte.
Quando receber o código de autenticação, introduza-o e selecione Enviar.
Aceitar os termos
Leia o Contrato do Integrador Global e o Manual do Programa. Selecione as caixas de verificação para confirmar que aceita os termos e, em seguida, selecione Aceitar.
Será apresentado um ecrã de confirmação. Clique em Gerir organização para editar os detalhes, se necessário.
Convidar utilizadores
Nota: apenas os administradores podem convidar utilizadores.
Selecione Gerir organização no menu de navegação esquerdo.
Aceda ao separador Utilizadores e selecione Adicionar utilizadores.
Preencha o formulário e atribua a função adequada ao(s) novo(s) utilizador(es): visualizador, contribuidor ou administrador.
Para saber mais sobre as funções de utilizadores, consulte o Guia de Administração da Organização.
Atribua projetos aos utilizadores (se aplicável) no menu pendente Projetos.
Introduza os endereços de e-mail de cada utilizador e, em seguida, selecione Convidar.
Juntar-se a uma organização existente
Peça um convite: peça ao administrador da sua organização que lhe envie um convite. Tem 24 horas para aceitar o convite antes de expirar. Se necessário, peça ao administrador para o reenviar.
Aceite o convite: inicie sessão com a ID de utilizador e a palavra-passe existentes. Se a sua ID já estiver associada a outra organização, tem de criar uma nova.
Juntar-se a uma organização existente
Passo 1: peça ao administrador da sua organização que lhe envie um convite.
Se a sua empresa já tiver criado uma organização, peça ao administrador da organização para lhe enviar um convite para se juntar à mesma. Terá 24 horas para aceitar o convite. Se não o aceitar durante esse período, pode sempre pedir que reenvie o convite.
Passo 2: aceite o convite.
Para aceitar o convite, terá de iniciar sessão com a sua ID de utilizador e palavra-passe existentes ou, se a sua ID de utilizador existente já estiver associada a uma organização, terá de criar uma nova.
Criar um projeto de API
Visite a página Os meus projetos e abra o separador API. Clique no botão Criar projeto de API.
Passo 1: selecione as API que pretende incluir no seu projeto
Reveja as quotas da API, os limites de tarifas e os detalhes de validação da API.
Passo 2: configure os detalhes do projeto
- Dê ao seu projeto um nome que seja identificável e exclusivo da sua organização.
- Selecione quaisquer países de onde pretende enviar para que lhe possamos atribuir uma conta de expedição de teste. Para testar a expedição de volumes a nível nacional num país europeu, é necessário ter uma conta de teste separada para cada país. Pode sempre adicionar/remover países mais tarde.
- Para receber notificações sobre as últimas atualizações de API e quaisquer informações relacionadas com interrupções, defina as suas preferências de notificação.
Passo 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, verá um ecrã de confirmação. Em seguida, poderá ver as suas credenciais de teste no seu novo projeto.
Criar um projeto de webhook
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.
- Configuração de contas: o webhook de visibilidade integrada avançada requer uma conta de faturação localizada nos EUA e pelo menos uma conta de expedição, estes dois tipos de contas são mutuamente exclusivos. Apenas os administradores podem adicionar contas de faturação e expedição na página Gerir organização.
Criar um URL (redirecionamento) válido na sua aplicação ou plataforma de destino
O URL de destino será utilizado para receber códigos e mensagens de autenticação, bem como notificações de carga de webhook da FedEx. O seu URL tem de utilizar HTTPS para garantir a segurança. O seu URL será bloqueado se incluir o seguinte:
- Espaço de IP RFC1918
- fedex.com ou qualquer um dos seus subdomínios
- Endereços IP no URL (incluindo localhost, 127.0.0.1)
Gerar um token de segurança
Este token de segurança pode ser utilizado como uma chave secreta para autenticar e validar informações transmitidas entre a sua organização e a FedEx. O token de segurança tem de incluir o seguinte:
- Um comprimento mínimo de 26 carateres e máximo de 100 carateres
- 1 caráter em maiúsculas
- 1 caráter em minúsculas
- 1 caráter numérico
Exemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Depois de definir o URL e o token de segurança, pode criar um projeto de webhook. Visite a página Os meus projetos e abra o separador Webhooks. Clique no botão Criar um projeto de webhook.
Selecionar o tipo de subscrição
Os Expedidores FedEx podem subscrever os respetivos eventos através de números de conta ou números de rastreio.
Passo 1: confirme a sua conta de faturação e selecione as funcionalidades
- Reveja a conta de faturação predefinida indicada para confirmar ou selecione uma conta de faturação diferente da sua organização.
- Configure o seu projeto ao selecionar funcionalidades como opções de prova de entrega, opções de entrega estimada, eventos de rastreio e filtragem baseada em eventos.
Passo 2: introduza os detalhes do projeto
- Dê ao seu projeto um nome que seja identificável e exclusivo da sua organização.
- Forneça os detalhes do URL de destino e do token de segurança, que criou durante a autenticação de pré-configuração (veja os passos acima).
- Para receber notificações sobre as últimas atualizações de webhooks e quaisquer informações relacionadas com interrupções, introduza um endereço de e-mail e o idioma preferencial.
Passo 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, verá um ecrã de confirmação.
Podem existir passos adicionais com base na sua seleção do tipo de subscrição. Consulte a documentação para saber mais.
Na página Descrição geral do projeto de API, obtenha as suas credenciais de teste — chave da API, chave secreta e contas de expedição — no separador Chave de teste.
Passo 1: peça um token de acesso OAuth
O token de acesso OAuth tem de ser utilizado em cada transação da API. O token é válido apenas durante 1 hora, por isso terá de programar a sua aplicação para atualizar o token antes de a sessão expirar. Consulte a documentação da API Authorization para obter mais detalhes.
Passo 2: reveja a documentação da API
Clique na documentação de cada uma das suas API para ler o contexto empresarial de cada API, de forma a compreender melhor como a utilizar. Inicie sessão para transferir a recolha da API JSON através do botão na parte superior da página da documentação. Também pode rever pedidos de exemplo para o ponto final que corresponde à integração que pretende.
Passo 3: utilize a sandbox para testar transações de exemplo
Clique no ponto final pretendido no menu de navegação esquerdo para aceder à sandbox específica. Identifique os pedidos de exemplo que correspondem ao seu caso de utilização e, em seguida, utilize as suas credenciais de teste e os URL de teste da FedEx para implementar as suas chamadas no ponto final conforme descrito nos pedidos de exemplo. Verifique se as respostas às chamadas de API que recebe correspondem às apresentadas na documentação. Saiba mais sobre a nossa experiência de testes no Guia de virtualização da sandbox.
Testar webhooks
Os testes podem ajudar a garantir que o URL que criou é válido. Permitem que a FedEx identifique o seu URL e crie uma ligação ao mesmo para enviar dados. Além disso, podem fornecer-lhe dados de testes de amostra que podem ajudar a verificar e a confirmar se consegue processar dados de rastreio fornecidos na sua aplicação. No entanto, os testes não autenticam o seu URL. Consulte a nossa documentação sobre webhooks para saber como testar o seu URL de webhook.
Visite a página Descrição geral do projeto e abra o separador Chave de produção. Os projetos de subscrição da Visibilidade integrada avançada por número de conta não precisam de ser movidos para a fase de produção.
Passo 1: configure o projeto
- Mude o nome da sua chave conforme necessário.
- Reveja o número de conta que selecionou no passo 1 do fluxo de criação do projeto. Esse número é utilizado para mover o seu projeto para a fase de produção. Quando o seu projeto estiver nessa fase, pode adicionar mais contas conforme necessário.
Passo 2: obtenha as chaves do projeto
Copie a sua chave da API de produção e a chave secreta de produção será apresentada num local seguro. Para manter a sua chave secreta de produção em segurança, só a apresentamos uma vez. Se a perder, pode gerar uma nova.
Depois de obter as chaves do projeto e clicar em Seguinte, verá os detalhes do seu projeto no separador Chave de produção.
- Para adicionar mais contas de expedição ao seu projeto, clique em Editar na parte superior da tabela de contas de expedição.
Os passos de validação variam por região
Os passos seguintes só se aplicam a clientes nos EUA e no Canadá. Se residir fora destes países, visite a página Validação da API para encontrar suporte.
Algumas API exigem a validação de etiquetas de expedição para serem utilizadas no nosso ambiente de produção. Veja se a sua API exige validação.
Passo 1: Desenvolver e testar API FedEx com a sua aplicação com ligação à Internet
Depois de desenvolver a sua aplicação com ligação à Internet, pode concluir a fase de teste com as credenciais de teste: conta(s) de expedição, Chave da API e Chave Secreta de teste. A Chave da API e a Chave Secreta de teste serão apresentadas na página Descrição Geral do Projeto e podem ser vistas em qualquer altura.
Passo 2: Avance com o projeto para a fase de produção
Após efetuar todos os testes com as API FedEx, inicie o processo de validação ao avançar com o projeto para a fase de produção no FedEx Developer Portal. Após efetuá-lo com sucesso, poderá ver a Chave da API e a Chave secreta de produção. Só pode ver a sua Chave secreta de produção uma vez, mas poderá gerá-la novamente mais tarde.
Passo 3: Preencha a Folha de Registo de Etiquetas
Preencha a Folha de registo de etiquetas com as informações de contacto adequadas, bem como os serviços que planeia implementar. Inclua o número da sua conta e a chave de produção.
Passo 4: gere e envie as etiquetas de teste para o Grupo de análise de códigos de barras
Gere etiquetas de teste no ambiente de teste FedEx associado à aplicação e, em seguida, envie-as às equipas de avaliação de etiquetas FedEx para aprovação. O Grupo de análise de códigos de barras precisa de um período de 3 dias úteis para a avaliação das etiquetas.
Siga estas boas práticas para evitar atrasos no processamento:
- As etiquetas têm de ser impressas e digitalizadas com um mínimo de 600 DPI. NÃO ENVIE FICHEIROS GERADOS PELAS API.
- No caso de impressoras térmicas, tem de pedir o tipo de imagem das etiquetas de acordo com o modelo da impressora. Exemplo: ZPLII para impressoras Zebra.
- Utilize as informações de endereço do expedidor/destinatário ao criar etiquetas de amostra para avaliação. Crie apenas etiquetas de amostra para os serviços específicos necessários.
- A etiqueta de Pagamento contra entrega (COD) FedEx® também tem de incluir a etiqueta de devolução de COD correspondente.
- As expedições FedEx International Express® também têm de incluir a etiqueta da Carta de porte aéreo (AWB) auxiliar/secundária.
- As expedições multi-peças (MPS) têm de incluir uma etiqueta para cada volume da expedição.
- Envie o PDF e a Folha de registo de etiquetas por e-mail para label@fedex.com.
- As etiquetas físicas podem ser enviadas para o endereço abaixo:
Serviços FedEx
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Se as etiquetas digitalizadas não apresentarem defeitos visíveis (por exemplo: linhas sobre o código de barras, manchas de tinta ou danos físicos), poderão passar na inspeção e obter aprovação.
Se enviar etiquetas físicas, tenha cuidado com a qualidade da impressão e com eventuais variações de tamanho das etiquetas (por ex.: dimensionamento). Estes são os dois principais motivos pelos quais as etiquetas não passam no processo de avaliação.
Passo 5: reveja a avaliação das etiquetas
O grupo de Análise de Códigos de Barras irá avaliar as etiquetas de teste enviadas e aprovar ou rejeitar as mesmas. O grupo de Análise de Códigos de Barras irá contactá-lo relativamente à aprovação ou rejeição das etiquetas enviadas. Se as etiquetas forem aprovadas, continue para o passo seguinte. Se as etiquetas forem rejeitadas, corrija as mesmas de acordo com as instruções e envie-as novamente para aprovação.
Passo 6: ative a aplicação
Quando as etiquetas de teste forem aprovadas para produção pelo Grupo de análise de códigos de barras, o mesmo irá autorizar as suas credenciais de produção para transmitir a transação da etiqueta de expedição identificada e enviar-lhe uma notificação por e-mail quando a validação for concluída com sucesso. A aprovação dos projetos é obtida individualmente.
Passo 7: Substitua o URL e as credenciais
Substitua o URL e as credenciais de teste pelo URL e as credenciais de produção. Volte a testar a implementação no ambiente de produção através de dados de amostra.
Pré-requisito
A sua empresa tem de ser um Fornecedor compatível FedEx existente. Se a sua empresa não fizer parte do Programa de compatibilidade, altere a sua seleção acima para "Fornecedor não compatível".
Passo 1: receba um convite para se juntar à organização
A FedEx irá criar uma organização e convidar um membro da equipa para juntar-se à organização. Este utilizador será designado o administrador da sua organização.
Passo 2: aceite o convite
Para aceitar o convite, terá de iniciar sessão com a sua ID de utilizador e palavra-passe existentes ou, se a sua ID de utilizador existente já estiver associada a uma organização, terá de criar uma nova.
Passo 3: convide utilizadores
Um administrador pode convidar utilizadores para a organização e atribuir-lhes funções e projetos. Abra o separador Utilizadores. Clique no botão Adicionar utilizadores.
- Selecione uma função de utilizador: Visualizador, Contribuidor ou Administrador. Saiba mais sobre as funções no nosso Guia de administração da organização.
- Se tiver projetos existentes, atribua um projeto ao utilizador. Também pode atribuir projetos aos utilizadores na página Descrição geral do projeto.
- Introduza os endereços de e-mail dos utilizadores que pretende que se juntem à sua organização com a função selecionada.
Aceda ao Catálogo de API para determinar as API ou os webhooks adequados para a sua solução. O Consultor de tecnologia do cliente FedEx (CTC) e o Gestor de canais compatíveis podem ajudar a selecionar as API adequadas para a sua solução, de acordo com as suas necessidades empresariais.
Passo 1: preencha a PIW
Contacte a Comunidade de fornecedores compatíveis (CPC) para preencher a Ficha de informações do produto (PIW).
Passo 2: reveja os projetos criados pela FedEx
Assim que a PIW for aprovada, a FedEx irá criar os seus projetos. A versão de cada uma das suas soluções terá um projeto separado no FedEx Developer Portal.
Passo 3: assista à demonstração de API com a sua equipa
A equipa do Programa de compatibilidade FedEx, juntamente com o CTC FedEx e as Equipas de verificação, irá organizar uma demonstração técnica para as API com a sua equipa. A equipa da FedEx irá discutir a Verificação do programa de compatibilidade, novas funcionalidades da API e responder a perguntas.
Na página Descrição geral do projeto de API, obtenha as suas credenciais de teste — chave da API e chave secreta — no separador Chave de teste.
Passo 1: crie chaves de clientes
Utilize a Credential Registration API para criar chaves de clientes. Trata-se de uma API privada que só pode encontrar na secção API, na parte inferior da página Descrição geral do projeto de API.
Passo 2: peça um token de acesso OAuth
O token de acesso OAuth tem de ser utilizado em cada transação da API. O token é válido apenas durante 1 hora, por isso terá de programar a sua aplicação para atualizar o token antes de a sessão expirar. Consulte a documentação da API Authorization para obter mais detalhes. Ao visualizar o código de exemplo, certifique-se de que escolhe "Revendedor" na lista de opções de exemplos.
Passo 3: reveja a documentação da API
Clique na documentação de cada uma das suas API para ler o contexto empresarial de cada API, de forma a compreender melhor como a utilizar. Inicie sessão para transferir a recolha da API JSON através do botão na parte superior da página da documentação. Também pode rever pedidos de exemplo para o ponto final que corresponde à integração que pretende.
Passo 4: utilize a sandbox para testar transações de exemplo
Clique no ponto final pretendido no menu de navegação esquerdo para aceder à sandbox específica. Identifique os pedidos de exemplo que correspondem ao seu caso de utilização e, em seguida, utilize as suas credenciais de teste e os URL de teste da FedEx para implementar as suas chamadas no ponto final conforme descrito nos pedidos de exemplo. Verifique se as respostas às chamadas de API que recebe correspondem às apresentadas na documentação. Saiba mais sobre a nossa experiência de testes no Guia de virtualização da sandbox.
Passo 5: verifique cada solução
Depois de testar totalmente as suas soluções, envie casos de teste para a Equipa de verificação a fim de verificar cada solução. A FedEx irá rever integralmente tudo o que for enviado e informar assim que a sua verificação for aprovada.
Testar webhooks
Se a sua organização tiver acesso a webhooks, os testes podem ajudar a garantir que o URL que criou é válido. Permitem que a FedEx identifique o seu URL e crie uma ligação ao mesmo para enviar dados. Além disso, podem fornecer-lhe dados de testes de amostra que podem ajudar a verificar e a confirmar se consegue processar dados de rastreio fornecidos na sua aplicação. No entanto, os testes não autenticam o seu URL. Consulte a nossa documentação sobre webhooks para saber como testar o seu URL de webhook.
Em seguida, a FedEx irá mover os projetos para a fase de produção. Visite a página Descrição geral do projeto de API e abra o separador Chave de produção. Clique na ligação Gerar chave secreta na coluna Chave secreta.
Agora pode voltar a testar a implementação no ambiente de produção através de dados de amostra.
Pré-requisito
Tem de ter um ID de utilizador FedEx e uma conta para iniciar sessão no FedEx Developer Portal e criar uma organização.
Crie uma organização, se ainda não existir uma na sua empresa, ou junte-se à organização existente da sua empresa.
Criar uma nova organização
Na barra de navegação, clique em Criar ou juntar-se a uma organização.
Nota: enquanto criador, é automaticamente designado como administrador da organização.
Os administradores podem:
Convidar utilizadores a juntarem-se.
Atribuir funções (por exemplo: contribuidor, visualizador) e projetos aos utilizadores.
Gerir contas de expedição.
Para saber mais sobre estas funções, consulte o nosso Guia de Administração da Organização.
Para o tipo de empresa, selecione "Vende ou fornece uma solução de software que utiliza a tecnologia FedEx e é um Fornecedor Integrador FedEx validado".
Forneça o nome da sua empresa, o URL do site e um nome da organização único. O nome da organização pode ser igual ao nome da sua empresa ou representar um grupo específico (departamento, divisão, região, localização). Esta informação é necessária para validar o seu pedido.
Nota: escolha um nome da organização que todos os outros utilizadores reconheçam (por exemplo: nome da empresa, departamento, região, localização).
Especifique a localização da sua empresa, bem como o local onde a sua solução de software será vendida ou no qual será distribuída.
Adicione a conta de faturação e autentique-a.
Nota: enquanto fornecedor de expedição e logística no Programa de Integradores FedEx, tem de utilizar o número da sua conta. Não pode utilizar o número da conta FedEx de um cliente.
Introduza o número da sua conta FedEx. Se não tiver uma conta FedEx, crie uma em fedex.com ou contacte um representante do Apoio FedEx.
Introduza uma alcunha da conta e o endereço de faturação associado à conta. Selecione Seguinte.
Nota: o endereço de faturação tem de corresponder aos nossos registos para esta conta. Esta será a conta de faturação predefinida da sua organização.
Para concluir a criação da sua organização, tem de autenticar a sua conta. Escolha uma opção de autenticação (telemóvel disponível apenas para Integradores nos EUA e no Canadá, e-mail ou SMS) e selecione Seguinte.
Quando receber o código de autenticação, introduza-o e selecione Enviar.
Aceitar os termos
Leia o Contrato do Integrador FedEx e o Manual do Programa. Selecione as caixas de verificação para confirmar que aceita os termos e, em seguida, selecione Aceitar.
Será apresentado um ecrã de confirmação. Clique em Gerir organização para editar os detalhes, se necessário.
Convidar utilizadores
Nota: apenas os administradores podem convidar utilizadores.
Selecione Gerir organização no menu de navegação esquerdo.
Aceda ao separador Utilizadores e selecione Adicionar utilizadores.
Preencha o formulário e atribua a função adequada ao(s) novo(s) utilizador(es): visualizador, contribuidor ou administrador.
Para saber mais sobre as funções de utilizadores, consulte o Guia de Administração da Organização.
Atribua projetos aos utilizadores (se aplicável) no menu pendente Projetos.
Introduza os endereços de e-mail de cada utilizador e, em seguida, selecione Convidar.
Juntar-se a uma organização existente
Peça um convite: peça ao administrador da sua organização que lhe envie um convite. Tem 24 horas para aceitar o convite antes de expirar. Se necessário, peça ao administrador para o reenviar.
Aceite o convite: inicie sessão com a ID de utilizador e a palavra-passe existentes. Se a sua ID já estiver associada a outra organização, tem de criar uma nova.
Criar um projeto de API
Aceda à página Os meus projetos e selecione Criar projeto.
Preencha o campo Nome do projeto. O formato de nome recomendado é "Nomedoprojeto_nomedaaplicação". Selecione Seguinte quando terminar.
Selecione a API e os produtos da Visibilidade Integrada Avançada para o seu projeto.
Nota: os produtos da Visibilidade Integrada Avançada estão disponíveis apenas para Fornecedores Integradores FedEx nos EUA.
Nota: se selecionar produtos pagos, terá de atribuir uma conta de faturação ao projeto e aceitar os termos exigidos.
Atribuir faturação e aceitar termos
Atribua uma conta de faturação a partir da lista de contas adicionadas à organização. Este passo só é necessário se tiver selecionado um produto pago.
Aceite os termos e condições associados ao produto.
Confirmar detalhes
Reveja os produtos selecionados. Verifique a conta de faturação fornecida.
Reveja e aceite o Contrato de Licença do FedEx Developer Portal.
Clique em Criar para gerar o seu projeto e ver as credenciais de teste.
Configurar a Visibilidade Integrada Avançada num projeto
Pré-requisitos
Pré-requisitos
- Análise de preços: é cobrada uma taxa mensal aos subscritores com base na contagem de números de rastreio. Consulte o Formulário de pedidos para saber mais sobre os preços.
- Configuração de contas: a visibilidade integrada avançada requer uma conta de faturação localizada nos EUA e pelo menos uma conta de expedição, estes dois tipos de contas são mutuamente exclusivos. Apenas os administradores podem adicionar contas de faturação e expedição na página Gerir organização.
Crie um URL de redirecionamento válido na sua Aplicação ou Plataforma de destino. O URL da sua aplicação/plataforma:
Tem de utilizar HTTPS para garantir a segurança.
Não pode incluir o espaço de IP RFC1918, subdomínios de fedex.com ou endereços IP diretos (por exemplo: 127.0.0.1).
Gerar um Token de segurança
Tem de ter 26 a 100 carateres e incluir:
- 1 letra maiúscula
- 1 letra minúscula
- 1 número
Exemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Configurar a Visibilidade Integrada Avançada
Selecione Visibilidade Integrada Avançada. Selecione as funcionalidades, como prova de entrega, entrega estimada, eventos de rastreio e filtragem baseada em eventos.
Introduza o URL de destino e o token de segurança.
Forneça um e-mail para obter atualizações da Visibilidade Integrada Avançada e notificações de interrupção.
Confirmar detalhes
Reveja e aceite o Contrato de Licença do FedEx Developer Portal e o Formulário de pedidos.
Selecione Criar para concluir a configuração.
Nota: podem aplicar-se passos adicionais com base no seu tipo de subscrição. Consulte a documentação para obter mais detalhes.
Obter as credenciais de teste e começar a testar
Reveja a documentação da API
- Leia a documentação da API para compreender as várias API que disponibilizamos, bem como o respetivo contexto empresarial e os processos de integração.
- Transfira o esquema JSON a partir da página de documentação da API relevante.
- Reveja os pedidos de exemplo para os pontos finais desejados.
Obtenha as credenciais de teste
Na página Descrição geral do projeto, aceda ao separador Chaves de API. A sua Chave da API e a Chave secreta estão indicadas no cabeçalho Chave de teste.
Reveja a documentação da API
- É exigido um token OAuth para todas as transações de API, que expira no prazo de uma hora.
- A sua aplicação tem de atualizar o token antes de o mesmo expirar.
- Consulte a documentação da API Authorization para obter mais detalhes.
Teste transações de API na sandbox
- Aceda à API relevante no catálogo de API e selecione Documentação.
- Selecione o ponto final da API relevante no menu esquerdo.
- Utilize pedidos de amostra que correspondam ao seu caso de utilização.
- Implemente chamadas de API através das suas credenciais de teste e dos URL de teste da FedEx.
- Verifique as respostas comparando-as com a documentação.
- Consulte o Guia de Virtualização da Sandbox para obter mais detalhes.
Testar a Visibilidade Integrada Avançada
O teste da Visibilidade Integrada Avançada valida o formato do seu URL e ajuda a estabelecer uma ligação entre a FedEx e a sua aplicação.
O teste fornece dados de testes de amostra para processar as informações de rastreio.
Nota: os testes não autenticam o seu URL.
Aceda à documentação da Visibilidade Integrada Avançada para saber mais.
É exigida validação para mover API para a fase de produção. O nível de validação varia consoante a API.
Desenvolver e testar API da FedEx
- Utilize as suas credenciais de teste (chave da API e chave secreta) a partir da página Descrição geral do projeto.
- Identifique os casos de teste para as regiões/territórios onde planeia implementar a sua solução (consulte Normas dos casos de teste dos integradores).
- Antes de executar os casos de teste, conclua as transações de registos através dos números de conta de teste fornecidos.
- Execute todos os casos de teste exigidos.
Aceda à página Descrição geral do projeto.
Selecione Pedir chaves de produção. A FedEx receberá o seu pedido de chaves de produção e irá enviar-lhe uma notificação quando as mesmas estiverem aprovadas.
Preencher a PIW e a Folha de rosto de validação
Preencha a Ficha de informações do produto (PIW) e a Folha de rosto de validação de integradores com os seus detalhes de contacto e os serviços FedEx pretendidos.
Enviar documentos
Reúna e comprima o seguinte num ficheiro .zip para evitar restrições do fornecedor de e-mail. Envie para validationmtp@fedex.com.
Documentos exigidos
- PIW preenchida (PDF).
- Folha de rosto de validação preenchida (PDF).
Capturas de ecrã (PDF):
Solução orientada para o cliente com serviços/manuseamento especial da FedEx
Declaração de isenção de responsabilidade
Contrato de licença de utilizador final (EULA)
Fluxo de registo de cliente final
- Transações de registos de clientes finais com Autenticação multifator (JSON).
- Etiquetas de expedição lidas para todos os casos de teste aplicáveis (PDF/PNG).
- Transações de envios para os três formatos de etiquetas: PDF, PNG e ZPL (JSON) (para Shipping e Rating API).
Boas práticas para evitar atrasos
- As etiquetas têm de ser impressas e lidas com um mínimo de 600 DPI.
- As etiquetas de impressoras térmicas têm de corresponder ao modelo da impressora em questão (por exemplo: ZPLII para impressoras Zebra).
- As expedições FedEx International Express® exigem uma etiqueta da carta de porte (AWB) auxiliar.
- As Expedições multipeças (MPS) têm de incluir uma etiqueta para cada volume.
Avaliação das etiquetas
A Equipa de validação irá aprovar ou rejeitar o seu envio.
- Se for rejeitado, faça correções e reenvie com base no feedback.
- Se for aprovado, receberá um e-mail a confirmar a validação bem-sucedida. Depois de receber o e-mail, as suas credenciais de produção serão autorizadas para transações de etiquetas de expedição.
Seguir instruções pós-validação
Reveja e implemente quaisquer requisitos pós-validação conforme necessário.
Quando receber a notificação a informar que as suas Chaves de produção foram aprovadas, obtenha-as a partir do separador Descrição geral do projeto.
- Copie e guarde em segurança a sua chave de API de produção e a chave secreta.
- A chave secreta só é apresentada uma vez. Se a perder, tem de gerar uma nova.
