Referencia de la API

Cada punto final de la API Notiondesk con sus parámetros, respuestas y ejemplos de código.

La API REST Notiondesk te permite gestionar tus centros de ayuda desde el código. Lee artículos, colecciones y entradas del registro de cambios, administra las redirecciones de página, actualiza la configuración, la marca y las integraciones, exporta análisis y comentarios de los lectores, y activa sincronizaciones desde Notion. Sigues escribiendo tu contenido en Notion: la API lo lee y lo sincroniza, no lo edita.

URL base

Envía todas las solicitudes a https://api.notiondesk.so. Las rutas de los puntos finales comienzan con /sites, y las solicitudes y respuestas utilizan JSON.

Autenticación

Cada solicitud lleva un token de portador en el encabezado Authorization:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • Clave API : para tus propios scripts, trabajos programados y CI. El propietario del espacio de trabajo o un administrador la crea en Configuración > Desarrolladores > Claves API. Las claves comienzan con nd_wsk_ y funcionan para todos los centros de ayuda del espacio de trabajo. Consulta Autenticarse con la API Notiondesk mediante claves API .

Cada punto final necesita un ámbito: read, write, sync o admin. La página de cada punto final muestra cuál es.

Ejemplos de código

Cada página de punto final enumera sus parámetros, el cuerpo de la solicitud y las respuestas, con ejemplos de código listos para copiar en cURL, JavaScript y Python.

Guías

  • Guías de inicio : claves API, OAuth, paginación y versiones, errores y límites de velocidad, y ejemplos.
  • Webhooks : recibe una solicitud en tu servidor cuando algo sucede en Notiondesk.