Guia para o EasyCargo API (parte 1)
Enquanto olhava o no nosso site, talvez tenha se deparado com o termo API. Esta abreviatura está intimamente relacionada com a indústria de TI, por isso, é possível que não compreenda completamente do que se trata este serviço e quais os benefícios que pode obter com ele. Discutiremos o que é uma API e como funciona. Achámos que valia a pena familiarizá-lo com este tópico, uma vez que, por exemplo, o ajudará a ampliar a funcionalidade do software da sua empresa. Assim, decidimos criar uma série de três partes para cobrir este tópico de uma forma fácil. Hoje focaremos na parte teórica. No final deste artigo, aprenderá o que os próximos artigos da série irão conter.
Fonte: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg
O diagrama acima mostra o papel do API de uma forma muito simples. Contudo, vale a pena responder à pergunta de antemão – o que é um API, afinal? A extensão do atalho é a application programming interface. Existem diferentes tipos de APIs – temos uma API REST. O seu significado não deve importar muito para si, por isso não nos vamos concentrar estritamente no tipo de API aqui. Uma interface de programação de aplicação é um conjunto específico de soluções através das quais pode utilizar os dados de outro serviço no seu próprio site ou software. O que é que isso significa? Se a sua empresa tem um serviço interno para tratar, por exemplo, de transporte, pode fazer o download de dados na sua conta no EasyCargo, que serão depois entregues diretamente no software da empresa.
No entanto, para comunicar com EasyCargo ou outro software através de API, ainda é necessária uma chave API. Ela permite-nos identificar o seu site quando interage com EasyCargo. Se desejar obtê-lo, por favor entre em contacto connosco pelo e-mail assistencia@easycargo3d.com ou utilize o nosso formulário de contacto. Assim que a chave for gerada, pode encontrá-la a partir do seu perfil de utilizador no canto superior direito, clicando no botão Mostrar chave API.
Lembrete: manuseie a sua chave API como se fosse a sua senha da conta – guarde-a para si.
Com as informações mais importantes sobre APIs explicadas, podemos finalmente avançar para esclarecer o papel da interface de programação da aplicação, com base no diagrama acima.
Pensamos que com esta parte do artigo já entendeu a ideia de como funciona a API. Pode encontrar a interface de programação da aplicação EasyCargo neste link. Queremos ainda chamar a sua atenção para o facto de que todos os exemplos de consulta na documentação API são escritos utilizando HTTP. Recomendamos a utilização do protocolo HTTPS, por ser mais seguro.
Em resumo, a primeira parte da série concentrou-se principalmente em explicar o que é o API e qual é a ideia por detrás dele. O próximo artigo será mais prático. Tentaremos torná-lo mais familiarizado com a utilização do API para EasyCargo, entre outras coisas utilizando o nosso API client. Verá por si mesmo que as consultas apropriadas à interface de programação do EasyCargo resultam nos dados solicitados. Na última parte da série, discutiremos o que a comunicação através do API com o EasyCargo torna possível.
