API REST

Conectar un sistema que ya operas: directo, o por medio de un conector.

Cualquier cosa que pueda hacer una solicitud HTTP puede emitir credenciales. Más allá del API, hay dos formas de mantener a Nomi al día con un sistema sin escribir un sincronizador.

Conectores

Un conector es todo lo que mete personas en la plataforma: la subida de un CSV, una entrega por SFTP, una consulta programada contra un sistema de origen, o aprovisionamiento SCIM desde un proveedor de identidad. Todos desembocan en una sola operación —dar de alta un subject—, que es por lo que una hoja de cálculo y un proveedor de identidad producen el mismo resultado.

• POST /v1/connectors — crear uno; PATCH y DELETE para mantenerlo.
• POST /v1/connectors/{id}/upload — entregarle un archivo.
• POST /v1/connectors/{id}/sync — correrlo ahora.
• POST /v1/connectors/preview — ver qué haría un archivo antes de que lo haga.
• GET /v1/connectors/{id}/runs — qué hizo cada corrida.
• /scim/v2/Users y /scim/v2/Groups — SCIM 2.0, para que un proveedor de identidad empuje personas directamente.

Políticas

Una política es emisión declarativa: los subjects que calzan con una regla llevan una credencial. Se evalúa con un horario y con un límite de alcance — una regla cuyos datos se derrumban levanta una alerta en vez de revocarle la credencial a media empresa.

• POST /v1/policies — definir una.
• POST /v1/policies/{id}/preview — a quiénes afectaría, antes de afectarlos.
• POST /v1/policies/{id}/apply — correrla.

La forma de una integración

1. 1

   Da de alta cuando algo cambie

   Cuando cambie tu registro, PUT /v1/subjects. Es idempotente, así que una resincronización completa es segura.

2. 2

   Emite una sola vez

   POST /v1/credentials con un Idempotency-Key derivado de algo estable de tu lado.

3. 3

   Escucha

   Suscríbete a credential.* para que tu sistema sepa cuándo se instaló un pase, cuándo falló o cuándo lo quitaron.

4. 4

   Termina a propósito

   Revoca o suspende desde el mismo evento que termina la relación en tu sistema.