Guia de l’API d’EasyCargo (part 1)
En navegar per la nostra pàgina web és possible que us hàgiu trobat amb el terme API. Aquesta abreviatura està estretament relacionada amb la indústria de la informàtica, per la qual cosa és possible que no entengui del tot en què consisteix aquest servei i quins beneficis en pot obtenir. Analitzarem què és una API i com funciona. Pensem que val la pena familiaritzar-se amb aquest tema, ja que, per exemple, us ajudarà a ampliar la funcionalitat del programari per a la vostra empresa. Així que hem decidit crear una sèrie de tres parts per cobrir aquest tema de manera apropiada. Avui ens centrarem en la part teòrica. A la conclusió d’aquest article, coneixerà el contingut dels propers articles de la sèrie.
Font: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg
El diagrama anterior mostra el paper de l’API de manera molt simple. Tanmateix, val la pena respondre la pregunta per endavant: què és una API? L’acrònim significa interfície de programació d’aplicacions. Hi ha diferents tipus d’API: nosaltres tenim una REST API. El seu significat no li hauria d’importar gaire, així que no ens centrarem estrictament en el tipus d’API aquí. Una interfície de programació d’aplicacions és un conjunt específic de solucions mitjançant les quals podeu utilitzar les dades d’un altre servei al vostre lloc web o programari. Què vol dir? Si la vostra empresa té un servei intern per gestionar, per exemple, el transport, podeu descarregar les dades del vostre compte a EasyCargo, que després s’enviaran directament al programari de l’empresa.
No obstant això, per comunicar-vos amb l’EasyCargo o un altre programari a través de l’API, caldrà una clau API. Això ens permet identificar el vostre lloc web quan interactua amb EasyCargo. Si voleu obtenir-la, poseu-vos en contacte amb nosaltres per correu electrònic a soporte@easycargo3d.com o mitjançant el nostre formulari de contacte. Un cop generada la clau, la podeu trobar des del vostre perfil d’usuari a la part superior dreta fent clic al botó Mostra la clau API.
Nota: utilitzeu la vostra clau d’API com ho faríeu amb la contrasenya del vostre compte: deseu-la per a vostè.
Havent deixat enrere la informació més important sobre les API, podem passar finalment a explicar la funció de la interfície de programació d’aplicacions basada en el diagrama.
Creiem que en aquesta part de larticle ja haurà entès la idea general de com funciona lAPI. Podeu trobar la interfície de programació d’aplicacions d’EasyCargo en aquest enllaç. Encara volem cridar la seva atenció sobre el fet que tots els exemples de consulta a la documentació de l’API estan escrits usant HTTP. Us recomanem que utilitzeu el protocol HTTPS més segur.
En resum, la primera part de la sèrie s’ha centrat principalment a explicar què és l’API i quina és la idea que la sustenta. El proper article serà més pràctic. Intentarem que us familiaritzeu amb l’ús de l’API d’EasyCargo, entre altres coses utilitzant el nostre API per a clients. Comprovarà per si mateix que les sol·licituds adequades a la interfície de programació d’EasyCargo donen com a resultat les dades requerides. A la darrera part de la sèrie, parlarem del que fa possible la comunicació a través de l’API amb EasyCargo.
