Configura la API REST

Cada producto de NimbusNexus es una API REST: JSON sobre HTTPS, con tu clave de API en la cabecera Authorization. Esta página te lleva de no tener ninguna clave a una primera llamada correcta. Elige un lenguaje en la parte superior de la página y los ejemplos lo siguen. REST significa curl; TypeScript, Python y Go usan el cliente HTTP habitual de cada lenguaje, sin necesidad de SDK.

1 · Obtén una clave de API

Apps: Webhooks, Inboxes, códigos QR y Request Bins. Abre API keys en la consola de tu cuenta y crea una clave para el producto al que quieras llamar. Cada clave pertenece a un producto. Elige allí su alcance: admin, read o, para Webhooks, también publish. Copia la clave cuando aparezca, porque se muestra una sola vez. Una clave de app es un JWT, así que empieza por eyJ.

Infraestructura: VMs, almacenamiento, bases de datos y red. Crea la clave en el panel, en Settings → API keys. Tiene el alcance de un proyecto. Autenticación explica los alcances y la rotación.

No pongas la clave en tu código fuente. Expórtala en tu shell o guárdala en tu almacén de secretos:

Shell

export WEBHOOKS_API_KEY="<your-api-key>"

2 · Envíala en cada petición

Envía la clave como token bearer. Las APIs de las apps también la aceptan como X-API-Key: <key>.

HTTP

Authorization: Bearer <your-api-key>

Cada producto tiene su propia URL base:

Producto	URL base
Webhooks	`https://webhooks.nimbusnexus.net/v1`
Inboxes	`https://inboxes.nimbusnexus.net/v1`
Códigos QR	`https://qr.nimbusnexus.net/v1`
Request Bins	`https://bins.nimbusnexus.net/v1`
Infraestructura	`https://api.nimbusnexus.net`

3 · Haz una primera llamada

GET /v1/auth/me en Webhooks devuelve la clave que has enviado: su alcance y el workspace al que pertenece. No lee nada más, así que cualquier clave válida puede llamarlo.

curl https://webhooks.nimbusnexus.net/v1/auth/me \
  -H "Authorization: Bearer $WEBHOOKS_API_KEY"

La respuesta indica tu workspace:

JSON

{
  "scope": "admin",
  "workspace_id": "<workspace-id>"
}

Los demás campos indican qué tipo de credencial es. Para una clave de API, email y created_at son null.

4 · Lee los errores

Una petición fallida responde con un estado 4xx o 5xx y un único formato de error en todos los productos:

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "…",
    "details": { "reason": "missing" },
    "request_id": "…"
  }
}

Decide en función de code, no del estado ni del mensaje. unauthorized significa que no ha llegado ninguna clave o que la clave se ha revocado. invalid_credential significa que la clave no es válida: emite una nueva, porque reintentar no servirá de nada. forbidden significa que la clave es válida pero no puede hacer esto: le falta el alcance o el rol, o el producto no está activado en tu workspace. Autenticación y Errores enumeran todos los códigos. Indica el request_id cuando contactes con soporte.

Próximos pasos

Referencia de la API: todas las operaciones de todos los productos, con la llamada en tu lenguaje.
SDKs y la CLI: las mismas llamadas, con los reintentos, la comprobación de firmas y la paginación resueltos por ti.
Inicios rápidos de los productos: Webhooks, Inboxes, Request Bins y tu primera VM.