Documentación de la API
La dab Nexus API está disponible a partir de la versión 1.20.
¿Qué es una API?
Una API (Interfaz de Programación de Aplicaciones) es un conjunto de reglas que permite que diferentes aplicaciones de software se comuniquen entre sí, compartiendo datos, funciones y características. La Nexus API permite a nuestros clientes recuperar información sobre Workspaces, tareas y ejecuciones desde dab Nexus, por ejemplo, para fines de generación de informes.
¿Cuáles son las principales funciones de una API?
- Get: por ejemplo, obtener una Task por su ID u obtener un Parameter por el ID del Analytic Group
- Post: por ejemplo, crear una Task o cancelar una Run
- Put: por ejemplo, actualizar la programación de la Task o deshabilitar una Task
- Delete: por ejemplo, eliminar un Workspace o una Task
¿Qué es la Nexus API?
La Nexus API pública proporciona acceso programático a dab Nexus. Puede utilizarse para administrar Workspaces, crear o programar tareas analíticas, activar y Monitor ejecuciones, y resolver identificadores de objetos y parámetros.
La API ofrece distintas funciones:
- Obtener uno o todos los Workspaces por ID o crear, actualizar o eliminar Workspaces
- Obtener una Task por ID, crear una nueva Task, actualizar la hora de inicio o la programación, deshabilitar o habilitar la tarea, o eliminar la Task
- Obtener una Run por ID o Task ID o cancelarla
- Obtener tipos de objetos como SAP Connections, SQL Connections o Parameter Tables por su ID o nombre
- Obtener todos los Parameters por el ID del Analytic Group o el ID del Extraction Package
Todos los endpoints están descritos en esta sección.
Cómo conectarse a la Nexus API
Para conectarse a la API necesitará una clave API. Puede encontrar toda la información en este artículo.
Códigos de estado HTTP
| Código | Explicación breve | Descripción |
|---|---|---|
| 200 | OK | La llamada a la API funcionó según lo esperado |
| 400 | Solicitud incorrecta | La solicitud no fue aceptada, a menudo por falta de parámetros obligatorios |
| 401 | No autorizado | La clave API no es válida |
| 402 | Solicitud fallida | Los parámetros eran válidos pero la solicitud falló |
| 403 | Prohibido | La clave API no tiene permisos para realizar la solicitud |
| 404 | No encontrado | El recurso solicitado no existe |
| 409 | Conflicto | La solicitud entra en conflicto con otra solicitud |
| 424 | Dependencia externa fallida | La solicitud no pudo completarse debido a una falla en una dependencia externa de Nexus |
| 429 | Demasiadas solicitudes | Se enviaron demasiadas solicitudes a la API en poco tiempo |
| 500 502 503 504 | Errores del servidor | Ocurrió un problema en el lado de dab Nexus |