Empezar con la API

La API REST de Acreditta te permite automatizar la emisión, consulta y gestión de credenciales digitales desde tus propios sistemas. Esta guía te lleva de cero a tu primera llamada autenticada.

1. Obtén tu API Key

1. Ve a Integraciones → API en el menú lateral.
2. Haz clic en Crear APIKey.
3. Escribe un nombre descriptivo para identificar la llave (por ejemplo, el sistema que la va a usar) y haz clic en Crear.

⚠️ Importante: el valor de la API Key solo se muestra una vez, en el momento de crearla. Guárdalo en un lugar seguro — no podrás volver a verlo desde la plataforma.

Con esto tienes un DeveloperUser: un usuario con nombre de usuario API User y contraseña API Key. Estos dos valores son los que usarás para autenticarte contra la API, no tu usuario y contraseña normales de Acreditta.

2. Autentícate y obtén tus tokens

Haz login contra el endpoint /login con tu API User y API Key:

curl -X 'POST' \
  'https://public-api.acreditta.com/login' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "YOUR_API_USER",
  "password": "YOUR_API_KEY_VALUE"
}'

La respuesta incluye dos valores:

• idToken: úsalo como Bearer Token (Authorization: Bearer <idToken>) en todas las llamadas siguientes.
• refreshToken: guárdalo para pedir un nuevo idToken cuando el actual expire, contra /login/refresh-token.

3. Haz tu primera llamada

Con el idToken puedes consumir cualquier endpoint protegido, por ejemplo el reporte de estado de credenciales:

curl -X 'GET' \
  'https://public-api.acreditta.com/report/credential/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ID_TOKEN'

Entornos disponibles

🔎 Fíjate en: usa siempre el sandbox mientras desarrollas tu integración — las credenciales que emitas ahí no cuentan contra tu cupo de producción.

Referencia completa

El listado completo de rutas, parámetros y esquemas de request/response vive en Swagger: https://public-api.acreditta.com/swagger/#/. Es la fuente de verdad — esta guía y las siguientes te orientan sobre cómo usar la API, no reemplazan esa referencia.

Flujo lógico de una integración típica

Una vez que puedes autenticarte, este es el orden habitual en el que una integración (por ejemplo, con un LMS o un ERP académico) suele usar los endpoints entre sí:

1. Autentícate contra la API con /login usando tu API User y API Key.
2. Permite que el administrador de tu institución asocie una plantilla de reconocimiento a su curso, buscando entre las plantillas de su organización con /template/list (admite un parámetro de búsqueda).
3. (Opcional) Permite que asocie también un flujo de aprobación al curso, listando los flujos disponibles de tu organización con /flows.
4. Persiste el credentialTemplateId y, si aplica, el flowId que el administrador seleccionó, asociándolos al curso dentro de tu propio sistema.

A partir de ahí, el camino se bifurca según si el curso quedó con un flujo de aprobación asociado:

Con flujo de aprobación:

5. Cuando un grupo de estudiantes cumpla las condiciones para recibir la credencial, abre un lote con POST /credential/batch/create y guarda en memoria el batchId que te devuelve.
6. Recorre el grupo de estudiantes y agrega cada uno al lote con POST /credential/issue, pasando el batchId como parámetro de consulta (?batch_id={batchId}).
7. Cuando termines de agregar estudiantes, cierra el lote con PATCH /credential/batch/close/{batchId}, indicando en el cuerpo el flowId que persististe en el paso 4 — eso es lo que dispara el proceso de revisión.

Sin flujo de aprobación (emisión simple):

5. Emite la credencial directamente cuando el estudiante cumpla las condiciones, con POST /credential/issue (sin batch_id).

🔎 Fíjate en: el parámetro batch_id es lo que determina si una emisión queda asociada a un lote en revisión o no — con o sin flujo de aprobación, el endpoint que emite siempre es el mismo, /credential/issue.

Siguiente paso

• Endpoints de la API — catálogo de rutas y ejemplos de uso.
• Planes y límites — confirma que tu plan incluye acceso a la API antes de integrar.

¿Necesitas ayuda?

Escríbenos a tech@acreditta.com si tienes dudas durante tu integración.