API de Enrolamiento

Quickstart

La primera llamada a la API de Enrolamiento, de las credenciales a la respuesta.

Esta guía lo lleva de las credenciales a la primera respuesta: dónde encontrar su APIKey en el portal del cliente, cómo consultar una certificación con curl, cómo leer lo que devuelve y cómo reconocer el error que más probablemente vea al empezar.

Qué necesita

  • Su usuario. Es el mismo con el que entra al portal del cliente: el RUT de su empresa, con guion y dígito verificador. Escríbalo igual que lo muestra el portal (con K mayúscula si corresponde).
  • Su APIKey. El portal la llama «Llave de acceso».

En la API conviven dos RUT distintos. El de su empresa, como proveedor de software, va solo en la credencial. El de la empresa cliente que usted certifica va en la URL de cada operación.

Para ver la APIKey, entre al portal del cliente y abra Mi Cuenta en el menú superior. En la pantalla Mis Datos, vaya a la pestaña Integración: la APIKey está en el campo Llave de acceso. Esa misma pestaña muestra el header Authorization ya armado con su usuario y su APIKey.

Si el campo dice «APIKey no generada», genere una con el ícono que está junto al campo y presione Guardar: la APIKey nueva no queda registrada hasta que guarda. Si ya tiene una, no genere otra para probar: la nueva reemplaza a la anterior (vea Autenticación).

Trate la APIKey como una contraseña: no la escriba en el código de su aplicación, no la suba a un repositorio y no la ponga en código que se ejecute en el navegador de sus usuarios.

La primera llamada

La operación certificaciones_v1_consultar, GET /v1/certificaciones/{rut}/consultar, devuelve los datos de una certificación dado el RUT de la empresa. Es una lectura: no cambia nada y se puede repetir sin riesgo.

curl -u '<usuario>:<apikey>' -H 'Accept: application/json' \
  https://api.enrolamiento.cl/v1/certificaciones/11111111-1/consultar

Reemplace <usuario> y <apikey> por sus credenciales, y 11111111-1 por el RUT de la empresa cliente cuya certificación quiere consultar, no por el suyo.

Escribir la APIKey en la línea de comandos sirve para esta primera prueba. Para el uso diario, vea en Autenticación cómo no dejarla en el historial del shell.

  • -u hace que curl arme el header Authorization: Basic … con su usuario y su APIKey. La API lo exige en cada request.
  • Accept: application/json pide la respuesta en JSON. Mándelo siempre. En los requests que llevan cuerpo, mande además Content-Type: application/json.

Esta operación no recibe ambiente. Las que sí lo reciben operan en producción si se omite, y también si el valor no se reconoce. Mientras prueba, páselo siempre explícito como ambiente=0 (homologación). Los detalles están en Ambientes.

Cómo leer la respuesta

Un 200 trae un objeto Certificacion en JSON. Este es un extracto del ejemplo del contrato:

{
  "RUT": "11111111-1",
  "Estado": 1,
  "Etapa": 2,
  "PasoEnSII": 2,
  "Comentario": "Set de prueba enviado al SII."
}
CampoEn el ejemploQué significa
Estado1El estado actual: 0 creada, 1 en progreso, 2 finalizada, 3 con error.
Etapa2La etapa en que va la certificación. 2 es el proceso en el SII.
PasoEnSII2El paso dentro del SII cuando Etapa es 2. 2 es el set de prueba.
ComentarioSet de prueba enviado al SII.El comentario del estado. Es útil cuando la certificación está en error.

Los estados, etapas y pasos llegan como números, no como texto. La respuesta completa trae más campos: están todos en la referencia de la operación, y qué significa cada valor a lo largo del proceso, en Ciclo de vida de una certificación.

El error más probable: 404

Si no hay una certificación para ese RUT, la API responde 404 con un cuerpo de texto plano, no JSON. Trae solo el mensaje, que empieza con No existe una certificación…, sin código de error delante. No lo parsee como JSON.

Ese es el único 404 que significa «la URL es correcta y la certificación no existe», así que reconózcalo por esa forma. Cualquier otro 404 quiere decir que la URL no corresponde a ninguna operación: por ejemplo, una ruta mal escrita. Ese 404 puede llegar como un JSON con la clave Message o como una página HTML del servidor web. No dependa de su contenido.

Para ver el status y los headers, agregue -i:

curl -i -u '<usuario>:<apikey>' -H 'Accept: application/json' \
  https://api.enrolamiento.cl/v1/certificaciones/11111111-1/consultar
Cuerpo del 404Qué significaQué hacer
Texto plano que empieza con No existe una certificación…La URL es correcta y no hay certificación para ese RUT.Revise el RUT. Para crear la certificación, vea Ciclo de vida.
Cualquier otro: JSON con Message, o una página HTMLLa URL no corresponde a ninguna operación.Compare la URL con la referencia.

Si en cambio recibe un 401, el problema está en las credenciales: vea Autenticación.

Qué leer después

En esta página