Resumen de la API de Genesis

La plataforma Genesis expone una API REST a través de HTTPS. Cada solicitud se realiza contra una URL base, se autentica con un token en el encabezado de la solicitud y devuelve JSON.

URL base

https://api.nxgen.cloud/api/v1

Cada ruta en estas páginas es relativa a ella: GET /user/me significa GET https://api.nxgen.cloud/api/v1/user/me.

Autenticación

Las solicitudes llevan un token en el encabezado auth-token. Consulte Autenticación para saber cómo obtener uno.

Recursos

Convenciones

• Los parámetros de ruta se escriben entre llaves, /site/{id}. Reemplace todo el marcador, incluidas las llaves.
• Los cuerpos de solicitud son JSON a menos que una operación indique lo contrario. En estas páginas se muestra un cuerpo como un esqueleto: los nombres de campo con el tipo esperado en lugar de cada valor, y (obligatorio) en los campos que deben estar presentes.
• Las tablas de respuesta enumeran cada estado que declara la especificación. 401 indica que el token faltaba o fue rechazado; 403 significa que era válido pero no tenía derecho al recurso.

Especificación versión 1.0.0.