API REST

  • icono de API REST
    Una API REST es una forma segura de integrar canales y aplicaciones en su helpdesk de Zammad. Ofrecemos una vía sencilla utilizando JSON (JavaScript Object Notation) como formato de datos. Esto garantiza un intercambio de datos eficiente y fiable entre ambas fuentes y le permite adaptar su helpdesk con sus propias integraciones.
  • Con Zammad, se aplica el principio "API First". Esto significa que puede hacer cualquier cosa con la API REST que se pueda hacer a través de la interfaz. Así, nunca volverá a tener interfaces API ausentes, incompletas u obsoletas. (Y un dato curioso: la propia interfaz es solo un cliente API escrito en JavaScript que se ejecuta en el navegador).

    La API REST/JSON de Zammad admite tres métodos de autenticación diferentes:

    • Autenticación básica HTTP (usuario/contraseña)
    • Autenticación por token HTTP (token de acceso)
    • OAuth2 (acceso por token)

    Existen tokens de API especiales que permiten restringir aún más los derechos de acceso. Esto minimiza la superficie de ataque y el alcance de los daños en caso de que un token caiga en las manos equivocadas.

    Formato de solicitud

    En cuanto al formato de solicitud, Zammad utiliza JSON para su API, por lo que debe establecer un “Content-Type: application/json” en cada llamada HTTP. De lo contrario, la respuesta será text/html. De este modo, puede realizar solicitudes CURL, por ejemplo, para tickets y usuarios.

    También es posible realizar una solicitud en nombre de un usuario diferente. Si tiene su propia aplicación y desea crear un ticket para el cliente (sin la información de que el usuario de la API ha creado este ticket), puede transferir al usuario de destino con la solicitud para crear el ticket en nombre del usuario cliente.

    Formato de respuesta

    Si una respuesta es correcta, se devolverá un código de estado HTTP en el rango 200 o 300. Si se ha creado o actualizado un elemento, se devolverán todos los nuevos atributos (incluidos los atributos generados en el servidor como created_at y updated_at).

    Clientes API

    Existen dos clientes API oficiales (PHP y Ruby), así como varios clientes mantenidos por la comunidad que permiten un uso aún más sencillo de la API.


    Todos los recursos admiten paginación.

    Encontrará más información sobre la API REST y detalles sobre cómo utilizarla en nuestra Documentación de administración.

    Descubre más funcionalidades

    Desde la gestión inteligente de tickets hasta integraciones perfectas, descubre todo lo que Zammad tiene para ofrecer.

    Todas las funcionalidades

    Juntos convertimos a tus clientes en fans.
    ¡Empieza la prueba gratis!