Guia para o EasyCargo API (part 2)
Como mencionámos na primeira parte do artigo, hoje vamos “abordar” o EasyCargo API mais do ponto de vista prático. Para tal, utilizaremos o nosso API client. Também iremos testar o funcionamento do API com a ferramenta online ReqBin. Que permite a comunicação com um servidor WWW, graças ao qual podemos fazer o download de dados de interesse do nosso Simulador de carregamento de contentores EasyCargo. Testar é uma coisa, mas na vida real, pode estar a usar um plugin Java para o seu software ou chamadas Javascript da SAP. Além disso, a plataforma Make e outros casos de utilização de API no mundo real estará no próximo post desta série.
Veja acima como funciona na ferramenta ReqBin
A imagem acima mostra API client para o EasyCargo. Para poder enviar qualquer pedido API para o servidor web, o cliente deve primeiro ser autorizado. Assim, o pedido de início é um POST http://go.easycargo3d.com/api/v1/authentication com o nome de utilizador e a chave API no programa. Receberá um token de autenticação do servidor na resposta. Cada pedido API subsequente (exceto se de outra forma indicado) deve ser autenticado através da adição do token obtido no seu cabeçalho. Vale a pena notar aqui que todos os pedidos API feitos são feitos em nome do proprietário do token. Os pedidos e respostas devem ser criados em formato JSON ou XML.
Agora que fomos autenticados, vamos finalmente chegar ao divertimento mais interessante do API. Vamos supor que o utilizador X tem os seguintes carregamentos armazenados na sua conta.
Iremos praticar os pedidos API sobre eles porque os carregamentos são provavelmente a parte mais importante do EasyCargo. Outros pedidos, tais como gestão de utilizadores são formuladas de forma semelhante, por isso acreditamos que cada leitor deste artigo será capaz de lidar com a criação de outros pedidos. Na nossa documentação API para EasyCargo, cada método da interface da programação é explicado.
Se tiver alguma dúvida, contacte-nos em assistencia@easycargo3d.com ou utilize o nosso Formulário de contacto.
Solicitação de API sobre carregamentos
Como a documentação API nos informa, com pedidos devidamente formulados podemos obter uma lista de todas os carregamentos no servidor, bem como dados sobre uma carga específica a partir da conta EasyCargo. Podemos até criar ou apagar um carregamento da conta.
Lista de todos os carregamentos
Veja acima como funciona na ferramenta ReqBin
Aquisição de dados sobre um carregamento específico
Veja acima como funciona na ferramenta ReqBin
Crie um carregamento
Veja acima como funciona na ferramenta ReqBin
Como pode ver, a carga foi salva com sucesso na sua conta EasyCargo.
Pode simplesmente abrir o carregamento criado pelo método API na sua aplicação.
Apagar o carregamento
Veja acima como funciona na ferramenta ReqBin
O carregamento foi corretamente removido da sua conta EasyCargo devido a solicitação adequada.
Mais algumas informações sobre o API
- O número das suas solicitações API é limitado no tempo (60 solicitações por 1 hora). As cotas são verificadas através de um determinado período de tempo, só é permitido o número especificado de pedidos.
- Os erros API são enviados de volta por códigos comuns de HTTP. Na maioria dos casos, a resposta contém uma mensagem específica sobre qual foi o erro.
- O cálculo do planeamento da carga não pode ser executado através do API.
- O seu cliente API tem de aceitar o acesso e a modificação do cabeçalho do pedido e da resposta, bem como a análise dos dados em formato JSON ou XML.
- O utilizador do API tem de iniciar a sessão na aplicação EasyCargo para que o cálculo do plano de carga possa ser processado.
- Alguns métodos API suportam a utilização de parâmetros opcionais, tais como de. Naturalmente, aprenderá o significado de cada um deles a partir da documentação. Pode utilizar estes parâmetros, por exemplo, ao solicitar uma lista de todas as cargas úteis. Basta adicioná-los ao endereço do recurso após o caracter “?”, separados pelo caracter “&” no formulário nome=valor, por exemplo: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.
Na conclusão deste artigo, o API é um serviço muito útil. Esperamos que esta descrição prática lhe tenha explicado mais sobre como funciona uma interface de programação. O artigo de hoje é o segundo de uma série sobre a API para EasyCargo, por isso, se ainda não viu a primeira parte, pode encontrá-la aqui. A interface de programação abre para várias possibilidades. No próximo post, descobrirá os benefícios que pode obter com a utilização da nossa API e aprenderá com base em projetos da área.
