REST API

Cómo obtener tu clave API de Nozbe

Para generar tu token API, presionando el ícono de ajustes → Ajustes → API tokens y haz clic en “Añadir nuevo token”.

Puedes crear un nuevo token allí y nombrarlo, por ejemplo, “API de Nozbe”. Puedes generar más tokens para usar cada token con una integración/aplicación diferente.

De forma predeterminada, los tokens de API que agregues darán acceso solo al espacio en el que los estés creando. Si deseas agregar un token que brinde acceso a todos tus espacios, activa la opción “Añadir como token global”.

¡No compartas tu clave API con nadie! Tu clave API debe permanecer privada. Si se la muestras a alguien, sería como regalar tu correo electrónico y contraseña. Si compartes tu clave API o la publicas en algún lugar, corres el riesgo de filtrar tus datos.

Usa apikey <API_token> como encabezado de autorización al acceder a la REST API de Nozbe

Cómo utilizar la documentación de la API interactiva

1. Ve a la documentación interactiva de la API de Nozbe en https://api4.nozbe.com/v1/api
2. Selecciona “Authorize” y proporciona tu apikey <API_token>

3. Comienza a usar la documentación de la API interactiva seleccionando “Try it out” en el endpoint y ejecutando solicitudes con Execute.

Cómo generar clientes API con OpenAPI Generator

Nozbe proporciona un documento OpenAPI 3.0 en:

https://api4.nozbe.com/v1/api/openapi.yaml

La integración con la API de Nozbe se puede simplificar generando código de cliente usando OpenAPI Generator (https://openapi-generator.tech/).

La lista de generadores de clientes disponibles se puede encontrar aquí:

https://openapi-generator.tech/docs/generators#client-generators

Integración ejemplar de Ruby con la API de Nozbe:

1. Instalar OpenAPI Generator https://openapi-generator.tech/docs/installation/
2. Generar código de cliente con(“ruby” se puede reemplazar con otro generador disponible):

openapi-generator-cli generate -i https://api4.nozbe.com/v1/api/openapi.yaml -g ruby -o /tmp/test/

3. Si README.md ha sido generado, sigue las instrucciones de este archivo para compilar y configurar el cliente. Asegúrate de usar apikey <API_token> como encabezado de autorización. Los métodos de cliente generados se pueden usar para comunicarse con el servidor de Nozbe. A continuación se muestra un ejemplo del uso de métodos de cliente de Ruby generados para obtener el proyecto de Tareas sueltas y crear una tarea y un comentario.