Zendesk
Zendesk funciona con DeveloperHub en ambas direcciones. Nuestra aplicación DeveloperHub Docs coloca su documentación publicada dentro de un ticket de Zendesk, y el Zendesk Web Widget incorpora el soporte de Zendesk en su documentación publicada.
Para traer en primer lugar los artículos de su centro de ayuda de Zendesk a DeveloperHub, consulte Importar desde Zendesk.
Aplicación de Zendesk
DeveloperHub Docs es nuestra aplicación para Zendesk Support. Añade un panel a la barra lateral del ticket donde sus agentes buscan en su documentación publicada e insertan directamente en su respuesta un enlace a la página correspondiente.
Los agentes dejan de buscar en su documentación en otra pestaña y de pegar direcciones a mano. Cada enlace apunta al encabezado exacto que coincidió, de modo que su cliente llega a la respuesta y no al inicio de una página larga.
Instálela desde el Zendesk Marketplace.

Antes de empezar
Necesita:
Una cuenta de administrador de Zendesk. Solo los administradores pueden instalar aplicaciones.
Un proyecto de DeveloperHub con documentación publicada. La aplicación solo busca en contenido publicado, por lo que los borradores y las versiones sin publicar nunca aparecen.
Un plan que incluya la API de búsqueda. Contáctenos si no está seguro.
Creación de una clave de API
La aplicación busca mediante una clave de API, y esa clave también determina en qué proyecto se busca. Créela en el proyecto cuya documentación deben ver sus agentes.
Abra Project Settings → API Keys.
Cree una clave nueva y dele un nombre que deje clara su finalidad, como
Zendesk app.En los permisos, active Search → Query the search API y nada más. Una clave limitada a la búsqueda no puede leer ni modificar nada más en su proyecto.
Guarde la clave y cópiela.
Instalación de la aplicación
En Zendesk, abra Admin Center.
Vaya a Apps and integrations → Apps → Zendesk Support apps.
Haga clic en Marketplace y busque DeveloperHub Docs.
Abra la ficha y haga clic en Install.
Zendesk muestra el formulario de configuración en cuanto termina la instalación. Puede volver a él más tarde desde Settings de la aplicación en Admin Center.
Ajuste | Qué introducir |
|---|---|
DeveloperHub API key | La clave que copió antes. |
Documentation version |
|
Link format |
|
La misma pantalla limita el panel a determinados roles o grupos de agentes, en Enable role restrictions y Enable group restrictions.
Haga clic en Install (o Update) para guardar.
Una instalación busca en un proyecto. Para cubrir varios productos con documentación independiente, instale la aplicación una vez por proyecto, cada una con su propia clave de API. Dé a cada instalación un nombre claro, ya que sus agentes las ven todas en la barra lateral.
Búsqueda desde un ticket
Abra cualquier ticket y busque el panel DeveloperHub Docs en la barra lateral derecha. Escriba al menos dos caracteres; los resultados aparecen mientras escribe.
Cada resultado indica el encabezado que coincidió, la sección de documentación y la página donde se encuentra, su versión y un fragmento con los términos de búsqueda del agente resaltados. A partir de ahí:
Haga clic en el título del resultado para abrir esa página en una pestaña nueva del navegador y revisarla antes de enviarla.
Haga clic en Insert link para añadir un enlace a ella en la respuesta que se está redactando.

Zendesk solo acepta contenido insertado al final de una respuesta abierta, así que escriba primero su mensaje y añada los enlaces después. Si necesita un enlace en mitad de una frase, muévalo una vez insertado.
Qué sale de Zendesk
Solo lo que un agente escribe en el cuadro de búsqueda se envía a DeveloperHub. El contenido de los tickets, los datos del solicitante y la identidad del agente nunca salen de Zendesk, y la aplicación no almacena nada por su cuenta.
Zendesk guarda su clave de API como un ajuste seguro y la añade a cada búsqueda en los servidores de Zendesk, por lo que nunca llega al navegador del agente y no se puede leer desde él.
La clave concede búsqueda y nada más. No puede leer, modificar ni publicar su documentación, y revocarla en DeveloperHub detiene la aplicación de inmediato.
Solución de problemas
Mensaje | Qué hacer |
|---|---|
DeveloperHub rejected the API key. | La clave es incorrecta, ha sido revocada o carece del permiso de búsqueda. Cree una nueva con Query the search API activado y péguela en los ajustes de la aplicación. |
The search API is not available on this project's plan. | Su plan no incluye la API de búsqueda. Contáctenos para que la activemos. |
No matching pages found, para algo que sabe que está documentado. | Compruebe el ajuste Documentation version: una versión que no contiene la página no puede devolverla. Establecerlo en |
Could not add the link. Open a reply on this ticket, then try again. | Zendesk acepta contenido insertado solo mientras hay una respuesta abierta. Haga clic en el cuadro de comentario y use Insert link de nuevo. |
Too many searches in a short time. | La API de búsqueda permite un número elevado pero limitado de solicitudes por hora en su cuenta. Espere un minuto e inténtelo de nuevo. |
Si el panel aparece en blanco, recargue el ticket. Si sigue en blanco, confirme en Admin Center que la aplicación está instalada y que su rol y grupo no están excluidos por una restricción de rol o de grupo.
Zendesk Web Widget
El Zendesk Web Widget incorpora el soporte de Zendesk en su documentación publicada. Para añadirlo, debe tener un plan con Etiquetas HEAD personalizadas activado.

Configuración del Zendesk Web Widget
Siga los pasos indicados en Quickstart - Web Widget (Classic) APIs. Añada la siguiente Custom HEAD Tag sustituyendo YOUR_SNIPPET_KEY por su propia clave:
Need help? Visit our community forums or contact us.