Como começar

Comece a sua integração como Fornecedor Compatível com a FedEx ao tirar partido do valor fornecido pelas API FedEx. As instruções seguintes irão guiá-lo em todas as fases do processo de extensão das funcionalidades e capacidades FedEx na sua solução.


Passo 1:

Procure as API necessárias à sua aplicação.

  • Aceda ao Catálogo de API para determinar as API adequadas para a sua aplicação.
  • Selecione uma API para aceder à respetiva descrição geral, ao registo de alterações e às principais funcionalidades.
Captura de ecrã da página Descrição Geral das Tarifas
  • Veja os documentos da API para saber mais sobre os elementos de pedido e de resposta, exemplos na linguagem de programação preferencial, códigos de erro e muito mais.
Captura de ecrã da página Documentação das Tarifas
  • Consulte os Anúncios para obter atualizações de serviços planeadas e saber as novidades.

Passo 2:

Registe-se ou inicie sessão para começar a integrar com as API FedEx.

  • Inicie sessão com a sua ID de utilizador e palavra-passe em fedex.com para começar a integrar com as API FedEx.
  • Se ainda não tiver uma ID de utilizador, registe-se gratuitamente.

Passo 3:

Crie ou junte-se a uma organização.

Se a sua empresa ainda não tiver uma, pode criar uma organização. Em alternativa, pode juntar-se à organização existente da sua empresa. Pode ter muitos utilizadores associados à sua organização, contudo não pode ter muitas organizações associadas a uma única ID de utilizador.

Se criar a sua própria organização, será automaticamente indicado como o Administrador dessa organização. Um Administrador pode convidar utilizadores a juntarem-se à respetiva organização, atribuir-lhes funções e projetos e gerir contas de expedição. Para saber mais sobre a função ideal de cada utilizador, consulte as nossas Orientações de Administração da Organização. Para criar a sua própria organização, clique em Os Meus Projetos e, em seguida, clique no botão "Criar Organização". Este botão só será apresentado se ainda não tiver associado a sua ID de utilizador a uma organização existente. A partir daí, pode começar a criar uma organização através dos seguintes passos (os que estiverem marcados com * são opcionais):

  • Introduza um nome para a sua organização.
  • Introduza os endereços de e-mail de todos os membros da equipa que pretende convidar. Serão adicionados automaticamente como Visualizador, sem projetos associados.*
captura de ecrã da página Criar a sua organização

Também pode juntar-se à organização da sua empresa ao concluir o seguinte:

  • Se a sua empresa já tiver uma organização criada, peça à Administração da organização que lhe envie um convite para se juntar à mesma. Terá 24 horas para aceitar o convite, mas se ultrapassar esta janela de tempo, pode pedir-lhe que envie novamente o convite.
  • Para aceitar o convite, terá de iniciar sessão com a sua ID de utilizador e palavra-passe existentes ou criar uma nova, se a sua ID de utilizador existente já estiver associada a uma organização.

Passo 4:

Adicione uma conta de expedição.

Um administrador pode adicionar as contas de expedição que forem necessárias no âmbito da organização. Para começar, clique no botão "Adicionar Conta" no separador Contas de Expedição, da página Gerir Organização . A partir daí, pode adicionar uma conta de expedição existente à sua organização através dos seguintes passos:

  1. Preencher as informações da conta
  • Introduza o seu número de conta, a alcunha da conta e o endereço de faturação associados à conta.
    Estas informações serão validadas para garantir que correspondem aos dados da conta, a fim de evitar atividades fraudulentas.

  • Para ver as contas de expedição associadas à sua ID de utilizador, aceda à página Administrador de Expedição. Para criar novas contas de expedição, entre em contacto com o seu Representante de Vendas FedEx.

captura de ecrã da página Adicionar Conta de Expedição
  1. Contrato de licença de utilizador final
captura de ecrã da página Celebrar EULA

Passo 5:

Adicione utilizadores à sua organização para começar a colaborar com os seus colegas.

Um Administrador pode convidar utilizadores para a respetiva organização e atribuir-lhes funções e projetos. Para começar, clique no botão "Adicionar Utilizadores" no separador Utilizadores, da página Gerir Organização. A partir daí, pode adicionar utilizadores através dos seguintes passos (os que estiverem marcados com um * são opcionais):

  1. Introduza os endereços de e-mail do(s) utilizador(es) que precisam de se juntar à sua organização. Introduza os vários endereços de e-mail ao carregar nas teclas de espaço, vírgula, ponto e vírgula ou Enter.
  2. Escolha uma função, se a opção predefinida Visualizador não corresponder às necessidades dos utilizadores.*
  3. Escolha um projeto associado à sua organização para atribuir utilizadores. Se ainda não criou um, essa questão será abordada no próximo passo.*
captura de ecrã da página Adicionar Utilizadores

Os Administradores terão sempre acesso a todos os projetos. Contudo, no caso dos Contribuidores ou Visualizadores, é necessário que lhes seja atribuído um projeto, a menos que o Contribuidor tenha criado o projeto. Quer um utilizador já tenha ou não aceitado o convite, pode atualizar rapidamente os seus projetos ou funções diretamente no separador Utilizadores no ecrã Administração da Organização. Tudo o que tem de fazer é clicar no cursor ao lado da função ou projeto e será apresentada uma lista de opções. Faça a sua escolha e selecione o botão "Aplicar" para guardar a sua seleção.

captura de ecrã da página Gerir Organização

Passo 6:

Crie um projeto para obter credenciais.

Na página Os Meus Projetos, um Administrador ou Contribuidor pode criar um projeto ao selecionar o botão "Criar Projeto". A partir daí, este pode começar a criar um projeto através dos seguintes passos (os que estiverem marcados com * são opcionais):

1.  Configurar o Projeto        

  • Atribua ao seu projeto um nome que seja identificável e exclusivo dentro da sua organização.
  • Comece por selecionar, pelo menos, uma API para adicionar ao seu projeto. Pode sempre adicionar ou remover outras API mais tarde.           
captura de ecrã do passo 1 para criar um projeto 

2. Aceitar os Termos

captura de ecrã do passo 2 para criar um projeto
       
         3.  Configurar o seu projeto
 
  • Selecione qualquer país onde pretenda expedir, 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, tem de ter uma conta de teste separada para cada país. Pode sempre adicionar/remover países mais tarde.*
  • Se pretende utilizar Devoluções FedEx SmartPost® ou FedEx Freight® LTL, selecione Sim.*
  • Depois de clicar no botão "Criar", verá um ecrã de confirmação. No âmbito do seu novo projeto, pode agora ver as suas credenciais de teste. 
captura de ecrã do passo 3 para criar um projeto

Passo 7:

Integre as API na sua aplicação e teste a respetiva implementação.

  1. Recupere as credenciais de teste (Chave de API, Chave Secreta e conta(s) de expedição) no separador Chave de Teste da página Descrição Geral do Projeto.
captura de ecrã da página Chaves de teste
  1. Peça um token de acesso OAuth que tem de ser utilizado em cada transação da API. A sessão do token é válida apenas durante 1 hora, pelo que terá de programar a sua aplicação para atualizar o token antes de a sessão expirar. Para obter mais detalhes, consulte os documentos de Autorização da API;
  2. Selecione os documentos para as API na sua página Chaves de Teste e leia o contexto empresarial para compreender melhor como utilizar a API selecionada. Reveja os pedidos de exemplo para o ponto final que corresponde à integração que pretende.
  3. Implemente as suas chamadas para estes pontos finais como descrito nos pedidos de exemplo e configure as mesmas para utilizar as suas credenciais de teste.
  4. Certifique-se de que as respostas às chamadas à API recebidas estão de acordo com as apresentadas na documentação.
  5. Teste a sua implementação de forma eficiente no âmbito do ambiente de testes FedEx, através das credenciais e dos URI de teste FedEx.

Passo 8:

Mova o seu projeto para a fase de produção.

Na página Descrição Geral do Projeto, clique no separador Chave de Produção. A partir daí, pode começar a mover o seu projeto para a fase de produção através dos seguintes passos (os que estiverem marcados com * são opcionais):

  1. Configure o Projeto.
  • Mude o nome da sua Chave de API de Produção.*
  • Neste passo, é necessário adicionar uma conta de expedição, mas pode adicionar outras após o seu projeto ter sido movido com sucesso para a fase de produção. Se não tiver contas de expedição associadas à sua organização ou se o EULA não tiver sido assinado para contas de expedição que estão adicionadas à sua organização, estas não serão apresentadas na lista de opções.
captura de ecrã do passo 1 da página Chaves de produção
  1. Obtenha as Chaves de Projeto.
  • Em seguida, a sua chave de API de produção e a Chave Secreta de produção serão apresentadas. Certifique-se de que as copia para um local seguro.
  • Para manter a sua Chave Secreta de produção segura, só apresentamos a mesma uma vez. Se a perder, poderá gerar uma nova.
captura de ecrã do passo 2 da página Chaves de  produção

Passo 9:

Conclua a integração.

  1. Algumas API requerem certificação básica ou de etiquetas de expedição para serem utilizadas no nosso ambiente de produção. Conclua o processo de certificação de qualquer API no seu projeto que tenha este requisito.
captura de ecrã de página Certificação
  1. Depois de todas as API terem sido certificadas e ativadas, atualize os pedidos de API ao substituir os URI, as chaves e as contas de expedição de teste pelos URI, chaves e contas de expedição de produção;
  2. Volte a testar a implementação no ambiente de produção através de dados de amostra.
  3. Desfrute das vantagens da nova integração!


Passo 1: 

A FedEx cria uma Organização de fornecedores compatíveis.

  • 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.
  • Após a conclusão da certificação e da integração, poderá distribuir a solução aos seus clientes com facilidade.

Passo 2:

Aceite o convite.

  • Para obter acesso à documentação e aos artefactos de integração da API, aceite o convite. Para aceitar o convite, terá de iniciar sessão com a sua ID de Utilizador e palavra-passe da FedEx ou criar uma nova se ainda não tiver credenciais.
captura de ecrã da página Inicie sessão para começar a integrar através das API FedEx

Passo 3:

Convide utilizadores para a sua organização.

  • Como Administrador, pode convidar membros da equipa que precisam de acesso ao projeto ou à organização. Para obter detalhes sobre funções diferentes, consulte o Guia de Administração da Organização.
captura de ecrã da página Gerir Utilizadores da Organização
  • Se a sua organização já tiver sido criada, peça à Administração da organização ou à FedEx que lhe envie um convite para se juntar à mesma. Terá 24 horas para aceitar o convite. Se ultrapassar este período de tempo, pode pedir que o convite seja novamente enviado.

Passo 4:

Selecione as API de que precisa para a sua solução.

  • Aceda ao Catálogo de API para determinar as API adequadas para a sua solução. O Consultor de Tecnologia do Cliente FedEx (CTC) e o Gestor de Canal Compatível podem ajudar a selecionar as API adequadas para a sua solução, de acordo com as necessidades da sua empresa.

captura de ecrã da página Catálogo de API
  • Selecione uma API para descobrir a descrição geral, os registos de alterações e as principais funcionalidades.

captura de ecrã da página Visão geral da API de Validação de Endereços
  • Veja a documentação da API para saber mais sobre os elementos de pedido e resposta, exemplos no seu idioma preferencial, objetos de erro e muito mais.

captura de ecrã da página Documentação da API de Validação de Endereços
  • Volte à Salesforce para preencher a Ficha de Informações do Produto (PIW) e indique as API que gostaria de adicionar à sua solução.


Passo 5:

A FedEx cria projetos.

Assim que a PIW for aprovada, a FedEx irá criar os seus projetos. Cada versão de cada uma das suas soluções terá um projeto separado no Portal de Desenvolvimento FedEx. Se um utilizador não for um Administrador da organização, terá de ser convidado para ver cada projeto. 

É também nesta altura que a equipa do programa Compatível com a FedEx, juntamente com o CTC FedEx e as equipas de certificação, irá organizar uma demonstração técnica para as API com a sua equipa. A equipa FedEx irá debater as novas funcionalidades disponíveis com a versão das API que está a adotar. A equipa poderá abordar questões técnicas relativas às API, testes de API e todos os processos que precisam de ser concluídos para iniciar o processo de certificação* de API.

* Certificação – o processo definido pelo Programa Compatível com a FedEx para satisfazer os Requisitos de Conformidade do Programa. A Certificação de Programa Compatível é necessária para garantir que todos os Fornecedores Compatíveis implementam, comercializam e distribuem a tecnologia FedEx aos expedidores (clientes), conforme definido pelos padrões de serviço e tecnologia FedEx.


Passo 6:

Integre as API na sua aplicação e obtenha certificação para o Programa Compatível.

  1. Terá agora acesso à Chave de API de Teste e à Chave Secreta de Teste para começar a executar transações. Pode recuperar as mesmas no separador Chave de Teste da página Descrição Geral do Projeto.
captura de ecrã da página Visão geral do separador de Chaves de Teste
  1. Para criar chaves de cliente, terá de utilizar a API de Registo de Credenciais, que é uma API privada apenas encontrada na secção API de cada um dos seus projetos.
  2. Assim que criar algumas chaves de cliente, solicite um token de acesso OAuth para ser utilizado com cada transação da API. A sessão do token é válida apenas durante 1 hora, pelo que terá de programar a sua aplicação para atualizar o token antes de a sessão expirar. Para obter mais detalhes, consulte os documentos de Autorização da API. Ao visualizar o código de amostra, certifique-se de que escolhe "Revendedor" na lista de opções de amostras.
captura de ecrã da página da lista de opções de "amostras" da API de Registo de Credenciais
  1. Selecione os documentos para as API na sua página Chaves de Teste e leia o contexto empresarial para compreender melhor como utilizar a API selecionada. Reveja os pedidos de exemplo para o ponto final que corresponde à integração que pretende.
  2. Implemente as suas chamadas para estes pontos finais como descrito nos pedidos de exemplo e configure as mesmas para utilizar as suas credenciais de teste.
  3. Certifique-se de que as respostas às chamadas à API recebidas estão de acordo com as apresentadas na documentação.
  4. Teste a sua implementação de forma eficiente no âmbito do ambiente de testes FedEx, através das credenciais e dos URI de teste FedEx.
  5. Depois de testar totalmente as suas soluções, certifique cada solução na Salesforce. A FedEx irá rever integralmente tudo o que for enviado e informá-lo assim que a sua certificação for aprovada.

Passo 7:

A FedEx move os projetos para a fase de produção.

  • Em seguida, a FedEx irá mover os projetos para a fase de produção.
  • Poderá ver a Chave de API de Produção no separador Produção da página Descrição Geral do Projeto.
captura de ecrã da página de versões Compatíveis com o link Gerar apresentado no separador Produção na Visão Geral do Projeto

Passo 8:

Gere a Chave Secreta de Produção.

  • A sua Chave Secreta de Produção terá de ser gerada ao clicar 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.
  • Desfrute das vantagens da nova integração!