Autenticación mediante API Key

Para acceder a la API de Integraciones es necesario disponer de una API Key proporcionada por Galduria Software.

La API Key identifica al partner que realiza la petición y debe enviarse en todas las solicitudes mediante la cabecera HTTP x-partner-api-key.

Importante

La API Key se entrega una única vez durante el proceso de integración. Guárdala en un lugar seguro, ya que será necesaria para realizar todas las llamadas a la API.

Cabecera HTTP

Todas las peticiones deberán incluir la siguiente cabecera:

x-partner-api-key: factal_pk_XXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Ejemplo de petición

POST /partners/users HTTP/1.1
Host: api.factal.es
Content-Type: application/json
x-partner-api-key: factal_pk_XXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Seguridad

La API Key es una credencial privada y debe mantenerse confidencial.

Se recomienda utilizarla únicamente desde aplicaciones de servidor.

No debe incluirse en:

• Aplicaciones web ejecutadas en el navegador.
• Aplicaciones móviles.
• Aplicaciones de escritorio distribuidas a usuarios finales.
• Código fuente accesible públicamente.

Si se sospecha que la API Key ha podido verse comprometida, contacta con Galduria Software para solicitar la generación de una nueva credencial.

API Key no válida

Si la API Key no existe, es incorrecta o el partner no está autorizado, la API responderá con el código HTTP 401 Unauthorized.

Respuesta

{
  "code": 401,
  "status": "ERROR",
  "message": "Unauthorized",
  "data": null
}

Siguiente paso

Una vez configurada la API Key ya puedes comenzar a utilizar la API de Integraciones.

El primer endpoint disponible permite crear usuarios asociados a un partner.