¿Cómo uso la API de Xubio?

Pasos para utilizar la API de Xubio

En la barra de navegación superior ingresa en “Configuración/ Integraciones”.
Luego selecciona “API de Xubio” y clickea “Nueva App Cliente”.
Deberás ingresar los siguientes campos:

  • Nombre de la Aplicación: Ingresa el nombre de tu aplicación con el que utilizarás la API de Xubio.
  • Descripción: Ingresa una descripción opcional para identificar a tu aplicación.
  • Dominio: Ingresa el dominio de tu aplicación. Este campo es opcional por lo que no es necesario que lo completes.

Has click en “Guardar” y ya tendrás disponible tu app cliente para usar la API de Xubio. De esta forma obtendrás tu Client_id y Secret_id para obtener un token al usar la API.

Estándares de nuestra API

  • Nuestra API es REST y utiliza autenticación OAuth2 con Client-ID y Secret-ID para la obtención de Tokens.
  • Rest es un estilo de arquitectura elegante y legible en donde se hace uso de los verbos HTTP para realizar las operaciones de alta (POST), baja (DELETE), modificación (PUT) y consulta (GET) de información.
  • El protocolo estándar OAuth2 permite que las aplicaciones puedan acceder de manera delimitada a los datos (u operaciones) ubicados en otro servicio o aplicación (proveedor de servicio) en nombre del usuario sin tener que darle las credenciales para ello (usuario/password, etc) a esta aplicación tercera.

Integrando nuestra API con tu sistema

  • Una vez obtenidos los Client_id y Secret_id, deberás obtener un Access Token válido haciendo un request a “https://xubio.com/API/1.1/TokenEndpoint”.
  • El response será un JSON con el Access Token, cuyo periodo de vida será de 1 hora (3600 segundos).
  • Tienes que renovar ese Token cada hora, o cada vez que utilices un recurso renovarlo para estar seguro de que no ha vencido.

Pasos para utilizar los recursos de la API de Xubio

  • Podrás realizar pruebas antes de la implementación inicial de tu integración o durante la implementación.
  • Para ello hemos creado nuestra documentación específica de la API, donde podrás utilizar y acceder a un detalle de nuestros recursos.
  • Te recomendamos acceder aquí y desde “Recursos de la API”, utilizando tu Client_id y Secret_id, hagas las pruebas que desees para conocer en detalle nuestra API.

Recomendaciones

  • Podrás crear tantas app cliente como desees.
  • Integrar tu sistema con nuestra API puede resultar complejo por lo que te recomendamos que consultes con un programador.
  • Para utilizar la API de Xubio deberás estar en un plan Plus o Premium.