Ir al contenido principal

7 consejos y trucos para usar la API clásica

Publicado en: Jamf Pro, Marketplace

La Classic API es una API RESTful y puede utilizarse para obtener fácilmente información acerca de dispositivos e iniciar acciones dentro de Jamf Pro. Quizás sea desarrollador y busque la forma de crear una integración que funcione a las mil maravillas con su propia solución. O puede que sea un administrador de Jamf Pro que acaba de estrenarse con la API. Sea cual sea su punto de partida, aquí encontrará siete trucos que le ayudarán al trabajar con la Classic API.

1. Lea nuestra documentación

Dedicamos mucho tiempo y esfuerzo a documentar la Classic API en el Jamf Developer Portal, que encontrará en https://developer.jamf.com. Aquí encontrará la página completa de API Reference para la Classic API, que incluye modelos de respuesta y ejemplos de datos para cada terminal. Incluso puede usar la función «Try It Out» para ejecutar llamadas a API con una instancia de muestra de Jamf Pro.

2. Empiece con un cURL sencillo

macOS incluye una fantástica herramienta de línea de comandos llamada cURL, que se utiliza para obtener o enviar datos usando diferentes protocolos. Resulta especialmente útil para interactuar con API. Aquí tiene un ejemplo de cómo usar cURL para interactuar con el terminal «Computers» de la Classic API:

 curl -s -u myserviceaccount:mypassword

Debería ver una respuesta XML con una lista de todos los ordenadores de su servidor de Jamf Pro.

3. Pruebe Postman

Aunque cURL es una opción práctica y rápida para empezar a interactuar con la Classic API, su funcionamiento puede resultar engorroso con el tiempo. Si cree que está preparado para pasar a otro nivel, le recomendamos que descargue Postman (https://www.getpostman.com). Postman es una herramienta de desarrollo de API que se está convirtiendo rápidamente en el referente para crear e interactuar con API REST. Postman le permite generar, guardar y analizar fácilmente solicitudes de API directamente a través de una sencilla interfaz.

4. Utilice JSON en lugar de XML

Muchos de nuestros clientes y socios que crean scripts de eventos para su ejecución en Mac, dispondrán ya de herramientas para analizar y serializar objetos en JSON. Si este es su caso, seguramente no le entusiasmará la idea de importar bibliotecas y módulos para trabajar con XML. Afortunadamente, la Classic API permite recibir datos en JSON. Para utilizar esta opción, solo tiene que ajustar la cabecera Accept en «application/json». Recuerde que JSON solo puede utilizarse para recuperar información desde la Classic API. Necesitará XML para los PUT, POSTS y DELETES.

5. Procúrese un SDK

Un SDK, o kit de desarrollo de software, es un conjunto de herramientas de desarrollo que permite a los que escriben software crear aplicaciones para su plataforma de desarrollo. Jamf no cuenta con un SDK oficial para la Classic API, pero nuestros clientes y socios han creado varios SDK no oficiales para distintos idiomas.

  • Python es uno de los lenguajes más utilizados para acceder a Jamf Pro como programador. Si utiliza Python, seguramente le interesará importar python-jss (o como mínimo tenerlo presente). Encontrará información sobre python-jss en https://marketplace.jamf.com/details/python-jss/.
  • Otro de los lenguajes que los clientes y socios de Jamf suelen utilizar para acceder a Jamf Pro es Ruby. Si es aficionado a Ruby, le interesará echar un vistazo a ruby-jss, que puede quitarle mucho trabajo. Si quiere saber más sobre ruby-jss, visite el Jamf Marketplace en https://marketplace.jamf.com/details/ruby-jss/.
  • JamfKit es un SDK que puede integrarse en un proyecto de Swift y le ahorrará todo el trabajo para acceder a terminales de Classic API. Para conocer todos los detalles sobre JamfKit, eche un vistazo a https://marketplace.jamf.com/details/jamfkit/.

Cualquiera de estas herramientas le ayudará a avanzar más rápido al trabajar con la Classic API.

6. Asegúrese de que los scripts utilizan cuentas de servicio y no una cuenta de administrador

Compartir datos de Jamf Pro es bastante sencillo. Envíe un nombre de usuario y una contraseña al terminal apropiado y podrá hacer lo que le interese en poco tiempo, como puede ver en los ejemplos anteriores. Sin embargo, es importante tomar las medidas de seguridad adecuadas. En este sentido, es fundamental crear una cuenta específica para cada script que puede acceder a Jamf Pro y configurar esa cuenta con los mínimos privilegios imprescindibles. Jamf Pro cuenta con un amplio abanico de privilegios para cuentas, lo que abre la puerta a unos ajustes muy precisos para garantizar la máxima seguridad en todo lo relacionado con la API.

7. Díganos qué necesita

¿Quiere hacer algo y no puede? Nos gustaría saberlo, porque nuestra misión es ayudarle. Como cliente de Jamf, puede acceder a asistencia para la API a través del proceso de asistencia estándar. Y si es desarrollador de Jamf, puede escribirnos a la dirección developer.relations@jamf.com. Si hay alguna función concreta que le gustaría que añadiéramos, envíenos una solicitud o vote la propuesta a través de Jamf Nation.