Ir al contenido

API

Todo lo que hace la app de Clauhub pasa por la misma API, en el mismo origen: https://clauhub.ai/api.

Cada servicio (dominio) publica sus procedimientos en una de dos formas:

Ruta Para qué
POST /api/rpc/<dominio>/<procedimiento> Los procedimientos del servicio (lectura y escritura).
/api/http/<dominio>/... Rutas HTTP propias de un servicio, como el inicio de sesión de identity.

Algunos dominios públicos: identity (cuentas, organizaciones, miembros, llaves de API), books (fiscal y contabilidad), crm, commerce, payments, supply, insights, data, agents, billing, collaboration y comms.

La referencia completa de procedimientos: Próximamente.

Una llave de API (API key) actúa como el usuario que la creó: lo que tú puedes hacer, la llave puede hacerlo. Se envía en el encabezado x-api-key.

  • Crear: POST /api/rpc/identity/apiKeys/create. La llave (ch_...) se muestra una sola vez; Clauhub guarda solo su hash. Opcionalmente le pones un nombre y un vencimiento.
  • Listar: POST /api/rpc/identity/apiKeys/list muestra el nombre de cada llave y si está activa, nunca la llave.
  • Desactivar o activar: POST /api/rpc/identity/apiKeys/update con enabled. Una llave desactivada deja de funcionar hasta que la actives.
  • Borrar: POST /api/rpc/identity/apiKeys/delete. Una llave borrada deja de funcionar para siempre.

Crear y administrar tus llaves desde la app: Próximamente.

Las llamadas rpc son POST con un cuerpo JSON: la entrada va en json, y la respuesta trae el resultado en json.

curl -X POST https://clauhub.ai/api/rpc/identity/profile/get \
-H "x-api-key: ch_..." \
-H "content-type: application/json" \
-d '{"json": null}'

Los procedimientos list paginan por cursor (limit, hasta 100 por página, y nextCursor hasta que sea null) o por offset, nunca por los dos a la vez. Cada entidad responde también count (cuántos coinciden con los filtros) y schema (sus campos, filtros, orden y acciones, con el permiso que pide cada una).

Estado Código Cuándo
400 BAD_REQUEST La entrada no es válida.
401 Sin credenciales, o con una llave desactivada o borrada.
403 PERMISSION_DENIED No tienes el permiso; el error lo nombra.
404 …_NOT_FOUND No existe, o no es tuyo.

Límites de uso y versiones: Próximamente.