relBase API Rest - Primeros pasos

Versión

La versión actual de la API es v1 y permite la creación de documentos tributarios electrónicos (DTE), cotizaciones y notas de ventas. Si se cambia la versión de la API, aumentaremos el número de versión y mantendremos un soporte estable para las direcciones URL antiguas. La documentación de cada endpoint se encuentra en la siguiente URL: https://apidocs.relbase.cl

 

Autenticación

La API utiliza una autenticación basada en un token de empresa y usuario. El token de la empresa debe ser solicitado a [e-mail] y el del usuario integrador debe ser creado para estos fines con los privilegios que se necesiten desde la cuenta de la empresa en relBase. El token de autenticación del usuario integrador se puede desactivar, cambiar o limitar los privilegios siempre desde relBase en la opción Configuración->Usuarios.

Siempre debe crear un nuevo usuario integrador para cada aplicación que desees conectar a relBase, no es recomendable reutilizar el token del usuario integrador.

Autenticación básica

Suponiendo que el token del usuario integrador es XXXXXX y el token de la empresa es YYYYYY , presentamos el siguiente ejemplo para hacer una llamada al endpoint de productos:

curl -H "company: YYYYYY" -H "authorization: XXXXXX" -X GET "https://api.relbase.cl/api/v1/productos"

Rate Limit

Puedes realizar un máximo de:

• 7 (siete) solicitudes por segundo.

Si excede este límite, obtendrá una respuesta 403 Prohibido (Límite de velocidad excedido) para solicitudes posteriores. Estos límites son necesarios para garantizar que los recursos se utilicen correctamente. Tu integración debe tener en cuenta estos límites y volver a intentar cualquier solicitud fallida, verifica el siguiente código de Ruby a modo de ejemplo:

tries = 0; max_tries = 3;
begin
  HTTParty.send(method, uri) # perform an API call.
  sleep 0.5
  tries += 1
rescue
  unless tries >= max_tries
    sleep 1.0 # wait the necessary time before retrying the call again.
    retry
  end
end

 

Paginación

Por defecto devolveremos 12 registros (productos, DTEs, etc.) por página.  Si el conjunto de resultados se pagina, se devolverá una estructura llamada meta que contiene información acerca de la paginación: 

"meta": {
  "code": 200, 
  "message": "success",
  "current_page": 1,
  "next_page": 2,
  "prev_page": -1,
  "total_pages": 50,
  "total_count": 591
}

Es tu responsabilidad verificar la página siguiente para ver si hay más objetos; lo haces mediante el uso del parámetro&page=2, &page=3y así sucesivamente. 

curl -H "company: YYYYYY" -H "authorization: XXXXXX" -X GET "https://api.relbase.cl/api/v1/productos?page=2"