La API de Sapita
Conecta tu propio software con tus libros. Cada clave está limitada a una empresa y al acceso que necesita, y puedes revocarla en cualquier momento.
Para qué sirve la API
La API es para desarrolladores que quieren trabajar con los libros de una empresa desde su propio software. Crea borradores de facturas, lee facturas e informes, envía documentos de proveedores a Sapita e importa archivos de extractos bancarios.
Cómo empezar
- Crea una clave en los ajustes de tu empresa. Ponle un nombre, elige sus permisos y, si quieres, una fecha de caducidad.
- Envía la clave con cada solicitud, por HTTPS, en la cabecera Authorization como token bearer.
- Lee la referencia de los puntos de acceso que permiten tus permisos y llámalos desde tu software.
Claves de la API y permisos
Cada clave pertenece a una empresa. Tiene permisos de lectura o escritura para las áreas que necesita, como facturas, informes o datos bancarios, y nada más. La clave se muestra una sola vez al crearla. Puedes revocarla en cualquier momento, y la revocación surte efecto en la siguiente solicitud.
Mantén las claves en secreto, fuera de repositorios de código públicos y del código del navegador. Si una clave se filtra, revócala en tus ajustes y crea una nueva.
Límites de solicitudes
Cada clave tiene un límite de solicitudes por periodo. Una solicitud por encima del límite recibe una respuesta 429 con una cabecera Retry-After, para que tu software pueda esperar y volver a intentarlo. Las solicitudes de creación aceptan una cabecera Idempotency-Key, así que un reintento tras un tiempo de espera no crea un segundo registro.
Los límites actuales, y los límites de uso razonable para escrituras y almacenamiento de documentos, figuran en la referencia.
Errores y versiones
Los errores usan el formato estándar problem details, así que cada uno indica su tipo, su estado y su causa. La versión forma parte de la ruta, como en /v1. Los cambios dentro de una versión solo añaden funciones, así que una integración creada hoy seguirá funcionando. Un cambio incompatible llegaría con una nueva versión.
El SDK
Con la API se incluye un cliente tipado para TypeScript y JavaScript. Se genera a partir del mismo documento OpenAPI que la referencia, así que sus tipos coinciden con las solicitudes que acepta el servidor. Reintenta las solicitudes seguras tras un límite de solicitudes o un error del servidor, y nunca registra tu clave.
Estado
La API forma parte de Sapita y está disponible para todos los clientes. La descripción OpenAPI de cada versión se publica en api.sapita.app/v1/openapi.json.