Tema
En este artículo se explica dónde encontrar y cómo utilizar la interfaz de programación de aplicaciones (API) pública de NinjaOne.
Entorno
- Documentación de NinjaOne
- API pública de NinjaOne
Descripción
Utilice la página de la API pública de NinjaOne para ver todas las solicitudes disponibles en NinjaOne y sus funciones, crear consultas de ejemplo y ver o copiar respuestas.
Selecciona un tema para obtener más información:
- Dónde encontrar los recursos de la API
- Explora la API
- Cómo probar o enviar una solicitud de API
- Recursos adicionales
Dónde encontrar los recursos de la API
Para obtener una lista completa de todas las consultas de la API, consulta la documentación de la API pública de NinjaOne, a la que puedes acceder desde el menú de recursos de Ayuda situado en la esquina superior derecha de NinjaOne. El enlace se encuentra en la parte inferior del menú.
La API pública de NinjaOne ofrece recursos adicionales sobre la sintaxis del filtro de dispositivos y los webhooks. Haz clic en los enlaces que aparecen en la documentación de la API para obtener más información:
- Sintaxis del filtro de dispositivos: explica los requisitos sintácticos para la cadena codificada en URL del parámetro del filtro de dispositivos.
- Webhooks: Describe cómo configurar una integración de webhooks.
Explora la API
NinjaOne ofrece una API pública para que puedas ver un índice completo de plantillas para las entidades de la API. Las operaciones disponibles incluyen los métodos de solicitud POST, GET, PATCH, DELETE y PUT.
Autorización
La API pública de NinjaOne utiliza OAuth 2.0 para autenticar las solicitudes. OAuth 2.0 permite a las aplicaciones obtener acceso a los recursos de NinjaOne que están disponibles a través de la API.
Haz clic en Autorización para consultar la documentación que describe los requisitos de autorización de la API pública de NinjaOne.
Cambios en la API
- Consulte la sección «Puntos finales de prueba de la API pública 2.0 » para saber cómo interactuar con la página.
Cómo probar o enviar la solicitud de API
Probar un método de solicitud
Mientras se encuentra en la API pública, puede probar y luego ejecutar un método de solicitud siguiendo estos pasos:
- Expanda una consulta para ver los detalles y haga clic en «Probarlo». Algunas consultas, como la de la Figura 7, pueden requerir que introduzca un parámetro. Los parámetros pueden ser opcionales para organizar o limitar los datos mostrados en una respuesta. Para saber cómo obtener un ID de parámetro, consulte la sección de este artículo titulada «Cómo encontrar identificadores de consulta».
- Después de introducir los parámetros necesarios, haz clic en «Ejecutar». La respuesta a la consulta aparecerá en la sección «Respuestas » de esa plantilla.
- Una vez completada la respuesta, puede copiar la URL de la solicitud o hacer clic en Descargar para guardar la respuesta como un archivo JSON.
Puede utilizar las solicitudes de API personalizables con plataformas basadas en GUI, como Postman, para navegar o realizar pruebas. Para aprender a utilizar Postman, consulte la documentación de Postman | Postman Docs (enlace externo). Para obtener asistencia sobre la aplicación Postman, consulte el centro de asistencia de Postman (enlace externo).
Probar los puntos finales de la API pública 2.0
Dentro de la versión beta de la API pública de NinjaOne, acceda a las consultas desde el menú de la barra lateral. Las solicitudes funcionarán de manera similar a la sección anterior, pero debe asegurarse de tener la autorización configurada antes de usarla. Consulte la documentación de NinjaOne: Autorización de la API pública 2.0 para aprender a configurar estos ajustes.
- Seleccione su consulta en el menú de la barra lateral para ver los detalles.
- Introduzca su autorización en el campo Token o sessionKey, dependiendo de su método de autorización preferido.
- Introduzca los parámetros, si es necesario.
- Haz clic en «Enviar solicitud de API».
- Consulte la respuesta.
Cómo encontrar identificadores de consulta
Ciertas consultas de la API pueden requerir que introduzcas un identificador, como el ID de una organización o de un dispositivo. En la mayoría de los casos, puedes utilizar las entidades y recursos del sistema central para encontrar estos datos. Los siguientes pasos proporcionan un ejemplo para obtener un ID de organización, de modo que puedas obtener una lista de ubicaciones dentro de la API pública de NinjaOne.
- Despliega la consulta /v2/organizations y haz clic en Probar. A continuación, haz clic en Ejecutar.
- Copia el valor de «id».
- Vaya a la consulta /v2/organization/{id}/locations.
- Haga clic en «Probar» y pegue el valor copiado en el campo «id ».
- Haga clic en «Ejecutar » y vea la respuesta.
Recursos adicionales
Consulte los siguientes recursos para obtener más información sobre la API de NinjaOne.