Quickstart

1. Consigue una claveCopy Anchor Link

Crea una API key desde la zona de integraciones de tu espacio. Dale un nombre reconocible, selecciona los scopes mínimos y guárdala una sola vez en un gestor de secretos.

2. Comprueba la conexiónCopy Anchor Link

curl --fail-with-body \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Accept: application/json" \
  "https://tu-espacio.nexgestion.es/api/v1/ping"

Una respuesta correcta confirma que la credencial es válida y que el espacio está disponible. No copies la clave en la URL.

3. Consulta capacidadesCopy Anchor Link

curl --fail-with-body \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Accept: application/json" \
  "https://tu-espacio.nexgestion.es/api/v1/capabilities"

Usa esta respuesta para detectar recursos, scopes y versiones habilitadas antes de mostrar funciones opcionales.

4. Realiza una operaciónCopy Anchor Link

curl --fail-with-body \
  -X POST \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: example-create-001" \
  -d '{
    "type": "person",
    "name": "Persona de ejemplo",
    "email": "persona@example.test"
  }' \
  "https://tu-espacio.nexgestion.es/api/v1/clients"

Los nombres de recursos disponibles dependen de los scopes y capacidades del espacio. Consulta la documentación del recurso antes de enviar datos reales.

Buenas prácticasCopy Anchor Link

• usa una clave por entorno y por integración;
• aplica timeout y reintentos con backoff;
• conserva el request_id de la respuesta;
• evita reintentar mutaciones sin Idempotency-Key;
• elimina o rota la clave si sospechas que se ha expuesto.