Ir o contido principal

Guía para conectar e consumir a API de Akisplataforma

Esta guía explica paso a paso como conectarse á API de Akisplataforma , que credenciais necesitas e como realizar consultas correctamente. O fluxo de conexión baséase no estándar OAuth 2.0 , o que significa que primeiro debes obter un token de acceso e despois usalo para acceder aos datos.

Que necesito para conectarme á API?

Para usar a API necesitas credenciais persoais.

  • Estas credenciais están dispoñibles na túa área de usuario do sitio web.
  • Na sección "API" atoparás a información que necesitas usar:
    • nome de usuario : ID de usuario para a API (atoparáso na área da API da túa conta de usuario).
    • contrasinal : Este é o mesmo contrasinal que usas para iniciar sesión no sitio web.
    • client_id : identificador de conexión á API (atoparáso na área da API da túa conta de usuario).
imaxe da sección da API na conta de usuario

Como inicio sesión?

Agora que xa tes as túas credenciais, podes conectarte. A conexión segue o estándar OAuth 2.0, que se caracteriza por un proceso de dous pasos :

  • Paso 1: Solicitar un token de acceso (autenticación).
  • Paso 2: Consumir a API usando ese token (consulta de datos).

Podes facelo mediante programación (JavaScript, Python, PHP, etc.) ou usando unha ferramenta como Postman. (Adxuntamos imaxes de exemplo nunha solicitude usando Postman.)

Paso 1: Solicitar un token de acceso

Debes facer unha solicitude POST ao URL: https://akisplataforma.es/oauth/token co seguinte contido no corpo da solicitude (formato application/json ):
{
"grant_type": "password",
"client_id": "TU_CLIENT_ID_API",
"username": "TU_EMAIL_API",
"password": "TU_CONTRASEÑA"
}

A seguinte imaxe mostra como facer a solicitude e a resposta esperada; a parte importante da resposta é o access_token :

imaxe de solicitude de token

Paso 2: Realizar a consulta de datos

Agora que xa tes o teu token, fai unha segunda solicitude para consumir calquera dos puntos finais da API publicados en https://akisplataforma.es/api-documentacion , por exemplo, para obter os datos relacionados coas noticias deberiamos facer unha consulta usando o método get ao punto final https://akisplataforma.es/api/news usando o token obtido previamente.

imaxe da consulta ao punto final de noticias