Cómo utilizar la API de BCdiploma
Requisitos previos
- La implementación de las interfaces descritas en este documento solo será posible después de configurar una primera plantilla (template) en el entorno de pruebas (staging) o de producción;
- El emisor debe obtener su clave API y el ID del emisor, que se utilizarán en las llamadas a la API. Están disponibles en la sección API de la pestaña “Administración” del backoffice, a la que solo pueden acceder los usuarios que hayan iniciado sesión con un perfil “Administración”. El tipo de clave API que debe generarse depende de las operaciones que se vayan a realizar: consulte la descripción de los tipos de clave API.
- El formato esperado para las fechas es el formato ISO YYYY-MM-DD.
Aspectos generales de la API
Para la mayoría de las llamadas REST, la autenticación es obligatoria.
La autenticación se realiza mediante una clave API, que debe definirse en el encabezado de cada llamada.
Encabezado HTTP obligatorio:
Authorization: Bearer <your API key>
Para obtener su clave API y el ID del emisor, consulte este artículo.
Los endpoints de las API son los siguientes:
- Pruebas (staging): https://api-staging.bcdiploma.com
- Producción (los datos se alojan en la zona UE, de forma predeterminada): https://api.bcdiploma.com
- Producción (los datos se alojan en la zona EE. UU., previa solicitud): https://api-cus.bcdiploma.com
Estos endpoints se indican como [API-URL] en la documentación que sigue.
Límites de uso
Las API de BCdiploma pueden utilizarse sea cual sea el plan que haya contratado.
En los endpoints [API-URL]
Se aplican simultáneamente dos tipos de límites:
- Límite sostenido (steady): número máximo de solicitudes permitidas en una ventana deslizante de 60 segundos.
- Límite de ráfaga (burst): número máximo de solicitudes permitidas en una ventana deslizante de 5 segundos, para absorber los picos puntuales.
| Tipo de endpoint | Límite sostenido (60 s) | Límite de ráfaga (5 s) |
|---|---|---|
| Sin autenticación (anónimo) | 400 | 50 |
| Con autenticación (Bearer) | 500 | 100 |
| Publicación | 240 | 20 |
/admin/login | 60 | 10 |
En los endpoints [TOOLBOX-URL]
| Endpoint | Límite (60 s) |
|---|---|
GET /pdfasync/:id | 1 |
GET /pdf/:id | 1 |
POST /pdf | 4 |