La API Notiondesk permite listar, configurar y desactivar las integraciones de terceros de tu centro de ayuda: proveedores de análisis, chat en vivo y gestores de etiquetas. Úsala para implementar la misma configuración de análisis o chat en varios centros de ayuda con un solo script.
| Método | Camino | Alcance | Hace |
|---|---|---|---|
GET | /sites/{site_id}/integrations | read | Enumera los proveedores configurados |
PATCH | /sites/{site_id}/integrations/{type} | admin | Configura un proveedor y lo activa. |
POST | /sites/{site_id}/integrations/{type}/disable | admin | Desconecta a un proveedor |
Configurar y desactivar proveedores requiere un plan que incluya integraciones.
proxy_urladminadminProveedores apoyados
type | Campo | Requerido | Formato | Guía de configuración |
|---|---|---|---|---|
google-analytics | tracking_id | Sí | Un ID de medición de Google Analytics 4: G- y 10 letras mayúsculas o dígitos, como G-ABCDEFGHIJ. | Google Analytics |
plausible-analytics | domain | Sí | El dominio de su sitio web está registrado en Plausible. | Análisis plausible |
plausible-analytics | proxy_url | No | El origen https desde el que se ejecuta el proxy del script, como por ejemplo https://plausible.example.com. | |
umami | website_id | Sí | Letras, dígitos, - y _ | Umami |
umami | proxy_url | No | El origen https desde el que se ejecuta el proxy del script, como por ejemplo https://umami.example.com. | |
intercom | app_id | Sí | Letras, dígitos, - y _ | Intercomunicador |
crisp | app_id | Sí | Letras, dígitos, - y _ | Crujiente |
helpscout | beacon_id | Sí | Letras, dígitos, - y _ | Ayuda a los Scouts |
google-tag-manager | container_id | Sí | Letras, dígitos, - y _, como GTM-ABC123. | Administrador de etiquetas de Google |
Cada valor es una cadena de hasta 255 caracteres. Ninguno es secreto: cada uno es un identificador que el script del proveedor necesita en la página. Notiondesk verifica el formato, pero no el identificador en sí, con el proveedor.
Enumera tus integraciones
curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"type": "plausible-analytics",
"settings": {"domain": "help.example.com", "proxy_url": null},
"enabled": true
},
{
"type": "crisp",
"settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
"enabled": false
}
],
"has_more": false,
"next_cursor": null
}| Campo | Significado |
|---|---|
type | El proveedor |
settings | Los campos del proveedor. null cuando el proveedor se activó en el panel de control sin estar configurado. |
enabled | Si el centro de ayuda carga el proveedor |
La lista incluye proveedores que están desactivados, sin un orden específico, y siempre cabe en una sola respuesta. Los proveedores que nunca se configuraron no aparecen en la lista.
Configurar un proveedor
Envía los campos del proveedor a su ruta. La ruta responde 200 OK con la integración.
curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"domain": "help.example.com"}'{
"type": "plausible-analytics",
"settings": {"domain": "help.example.com", "proxy_url": null},
"enabled": true
}- Una actualización siempre activa el proveedor. No existe el campo
enabled: para desactivar un proveedor, utilice la ruta disable.
- Un campo que omitas conserva su valor almacenado. Para volver a activar un proveedor configurado sin modificarlo, envía
{}.
- Para eliminar un proxy, envíe
"proxy_url": null.
- Cada actualización renueva por completo el centro de ayuda, borrando las páginas almacenadas en caché y reconstruyendo todas las páginas.
UA-proxy_urlhttpsvalidation_error{}Desactivar un proveedor
La ruta responde 204 No Content y su centro de ayuda deja de cargar el proveedor. Su configuración se mantiene, por lo que la lista aún lo muestra con enabled: false, y {} enviado a su ruta de actualización lo vuelve a activar.
Desactivar un proveedor que ya está desactivado, o uno que nunca se configuró, también responde a 204 y no cambia nada, por lo que un reintento siempre es seguro.
Errores
curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"| Estado | Cuando | code |
|---|---|---|
| 400 | Falta un campo obligatorio o está vacío, un valor no coincide con su formato o tiene más de 255 caracteres, un valor almacenado no cumple con su formato y el cuerpo lo omite, o el cuerpo tiene un campo desconocido. | validation_error |
| 403 | La clave carece del ámbito read o admin para cambios. | insufficient_scope |
| 403 | Tu plan no incluye integraciones, o el creador de la clave no puede cambiar este centro de ayuda. | permission_denied |
| 404 | El centro de ayuda no existe en tu espacio de trabajo, o type no es un proveedor compatible. | not_found |
Consulte Handle Notiondesk Errores de API, límites de velocidad y reintentos para obtener el envoltorio de error y los demás códigos.
Preguntas frecuentes
¿Puedo agregar un script personalizado con la API Notiondesk?
No. El código JavaScript personalizado solo se configura en el panel de control. Consulta la sección «Potencia tu centro de ayuda con JavaScript personalizado» .
¿Por qué mi clave no puede configurar las integraciones?
Para modificar las integraciones, se requiere el ámbito admin, que solo poseen las claves creadas por el propietario o el administrador del espacio de trabajo. Su plan también debe incluir integraciones.
¿Deshabilitar una integración elimina su configuración?
No. La configuración se mantiene y al enviar {} a la ruta de actualización del proveedor se vuelve a activar con ellos.
¿Puedo usar un ID UA- de Universal Analytics?
UA- de Universal Analytics?No. La API solo acepta identificadores de medición de Google Analytics 4, que comienzan con G-.