Pasar al contenido principal

Guía para conectarse y consumir la API de Akisplataforma

Esta guía explica paso a paso cómo conectarse a la API de Akisplataforma, qué credenciales necesitas y cómo realizar consultas de forma correcta. El flujo de conexión se basa en el estándar OAuth 2.0, lo que significa que primero debes obtener un token de acceso y luego usar ese token para acceder a los datos.

¿Qué necesito para conectarme a la API?

Para poder utilizar la API necesitas unas credenciales personales.

  • Estas credenciales están disponibles en tu área de usuario dentro de la web.
  • En la sección “API” encontrarás la información que debes usar:
    • username: Identificador de usuario para la API (lo encontrarás en la zona API de tu cuenta de usuario).
    • password: Es la misma contraseña que utilizas para autenticarte en la web.
    • client_id: Identificador de conexión a la API (lo encontrarás en la zona API de tu cuenta de usuario).
imagen de sección Api en cuenta de usuario

 

¿Cómo me conecto?

Ahora que ya tienes tus credenciales puedes realizar la conexión. La conexión sigue el estándar OAuth 2.0, que se caracteriza por funcionar en dos pasos:

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

Puedes hacerlo mediante programación (JavaScript, Python, PHP, etc.) o usando una herramienta como Postman. (Adjuntamos imágenes de ejemplo en una petición utilizando postman)

Paso 1: Solicitar un token de acceso

Debes hacer una petición POST a la URL: https://akisplataforma.es/oauth/token  con el siguiente contenido en el body de la petición (formato application/json):    
{    
 "grant_type": "password",    
 "client_id": "TU_CLIENT_ID_API",    
 "username": "TU_EMAIL_API",    
 "password": "TU_CONTRASEÑA"    
}

En la siguiente imagen se muestra cómo hacer la petición y la respuesta esperada, la parte importante de la respuesta es el access_token:    

imagen de petición de token

 

Paso 2: Realizar la consulta de datos

Ahora que ya tienes tu token haz una segunda petición para consumir cualquiera de los endpoints de la API publicados en https://akisplataforma.es/api-documentacion, por ejemplo para obtener los datos relativos a las noticias deberíamos hacer una consulta utilizando el método get al endpoint https://akisplataforma.es/api/news utilizando el token obtenido anteriormente

imagen de consulta a endpoint de noticias