Aquesta guia explica pas a pas com connectar-se a l'API d' Akisplataforma , quines credencials necessites i com fer consultes de forma correcta. El flux de connexió es basa en l'estàndard OAuth 2.0 , el que significa que primer heu d'obtenir un token d'accés i després utilitzar aquest token per accedir a les dades.
Què necessito per connectar-me a l'API?
Per poder fer servir l'API necessites unes credencials personals.
- Aquestes credencials estan disponibles a la vostra àrea d'usuari dins de la web.
- A la secció “API” trobaràs la informació que has d'usar:
- username : Identificador d'usuari per a l'API (ho trobareu a la zona API del vostre compte d'usuari).
- password : És la mateixa contrasenya que utilitzes per autenticar-te a la web.
- client_id : Identificador de connexió a l'API (ho trobareu a la zona API del vostre compte d'usuari).
Com em connecto?
Ara que ja tens les teves credencials pots fer la connexió. La connexió segueix l'estàndard OAuth 2.0, que es caracteritza per funcionar en dos passos :
- Pas 1: Sol·licitar un token daccés (autenticació).
- Pas 2: Consumir l'API fent servir aquest token (consulta de dades).
Pots fer-ho mitjançant programació (JavaScript, Python, PHP, etc.) o usant una eina com Postman. (Adjuntem imatges d'exemple en una petició utilitzant postman)
Pas 1: Sol·licitar un token d'accés
Has de fer una petició POST a la URL: https://akisplataforma.es/oauth/token amb el contingut següent al body de la petició (format application/json ):{"grant_type": "password","client_id": "TU_CLIENT_ID_API","username": "TU_EMAIL_API","password": "TU_CONTRASEÑA"}
A la següent imatge es mostra com fer la petició i la resposta esperada, la part important de la resposta és l' access_token :
Pas 2: Realitzar la consulta de dades
Ara que ja tens el teu token fes una segona petició per consumir qualsevol dels endpoints de l'API publicats a https://akisplataforma.es/api-documentacion , per exemple per obtenir les dades relatives a les notícies hauríem de fer una consulta utilitzant el mètode get a l'endpoint https://akisplataforma.es/api/news utilitzant el token
