Gestión de API

Módulo API

General

  1. ¿Cuál es el propósito de las API en ServiceDesk Plus?
  2. ¿Se puede editar la respuesta XML (salida)?

API REST

  1. ¿Cómo funciona la API Rest según los parámetros dados?
  2. ¿Cómo se realiza la autenticación en Rest API?
  3. ¿Cómo genero la clave API?
  4. ¿Cuáles son las operaciones que admite la API Rest?
  5. ¿Qué respuesta enviaría ServiceDesk Plus a la herramienta de terceros que utiliza la API REST para la operación "ADD_REQUEST"?
  6. ¿Cómo realizo la operación "Add_Notes" en la API REST?

Otros

  1. ¿Hay algún código VB Script de muestra para agregar solicitudes en la aplicación ServiceDesk plus?

General

  1. ¿Cuál es el propósito de las API en ServiceDesk Plus?

    La interfaz de programación de aplicaciones (API) se utiliza para integrar varias aplicaciones y facilitar el intercambio de datos entre ellas. La integración se puede lograr con aplicaciones o servicios web de terceros (externos) que sean capaces de enviar los datos a través del protocolo HTTP.


  2. ¿Se puede editar la respuesta XML (salida)?

    No es posible editar la respuesta XML ya que es el resultado de la acción realizada mediante API.

API REST

  1. ¿Cómo funciona la API Rest según los parámetros dados?

    Las operaciones realizadas con la API REST se basan en el parámetro de la operación y se envían a la URL a través del método HTTP POST. El formato de la URL es el que se muestra a continuación,

    http: // <nombre de servidor>: <número de puerto> / sdpapi / <módulo>


  2. ¿Cómo se realiza la autenticación en Rest API?

    La autenticación de la aplicación ServiceDesk Plus se basa en claves, es decir, se envía una clave API junto con la URL para cada operación. Esta clave está basada en técnicos y se puede generar para técnicos con privilegios de inicio de sesión. También se tiene en cuenta el rol asignado al técnico, por lo que la clave es válida solo para el rol asignado al técnico. Una vez que se genera la clave, la clave se transfiere manualmente a la aplicación integrada para que la aplicación pueda usar la clave para otras operaciones de la API. Si la clave no es válida (la clave está caducada o el inicio de sesión del técnico está deshabilitado), la operación falla y se propaga un error a la aplicación integrada.



  3. ¿Cómo genero la clave API?

    La autenticación entre ServiceDesk Plus y la aplicación integrada se realiza mediante una clave API. Se genera una clave única para un técnico con permiso de inicio de sesión en la aplicación ServiceDesk Plus.

    Para generar la clave de API, haga clic en Administrador -> Técnicos en Bloque de usuario.

    Si desea generar la clave API para el técnico existente, haga clic en el icono de edición junto al técnico.

    Si desea generar la clave API para un nuevo técnico, haga clic en el enlace Agregar nuevo técnico, ingrese los detalles del técnico y proporcione el permiso de inicio de sesión.

    Haga clic en Generar enlace debajo del bloque de detalles de la clave API. Puede seleccionar un período de tiempo para que la clave caduque utilizando el icono de calendario o simplemente retener la misma clave de forma permanente.

    Si ya se generó una clave para el técnico, aparece un enlace Regenerar.



  4. ¿Cuáles son las operaciones que admite la API Rest?

    La API REST solo admite operaciones relacionadas con solicitudes como,

    • Agregar nueva solicitud, editar, cerrar, eliminar y ver solicitudes existentes.
    • Agregar nuevas notas a una solicitud, editar, eliminar y ver notas existentes.
    • Agregar registro de trabajo a una solicitud, editar, eliminar y ver registros de trabajo existentes.

    Consulte el enlace para el modelo de atributos para Rest API
    https://help.servicedeskplus.com/api/rest-api.html



  5. ¿Qué respuesta enviaría ServiceDesk Plus a la herramienta de terceros que utiliza la API REST para la operación "ADD_REQUEST"?

    La aplicación devolvería el ID de solicitud como una respuesta XML.



  6. ¿Cómo realizo la operación "Add_Notes" en la API REST?

    Para agregar notas a través de la API REST, solo necesita analizar los campos de Notas predeterminados que ya están presentes en ServiceDesk Plus. Puede encontrar esos campos en Admin -> API -> RESTAPI -> Notes.

Otros

  1. ¿Hay algún código VB Script de muestra para agregar solicitudes en la aplicación ServiceDesk plus?

    Utilice el siguiente código para agregar una solicitud mediante el script VB:

    Oscuro

    fullUrl Como cuerda = Mi .Settings.ServiceDeskURL & "/ servlets / RequestServlet"

    Oscuro oWeb Como nuevo System.Net. WebClient ()

    Oscuro Parámetros Como nuevoNameValueCollection ()

    Params.Añadir (

    "operación", NewTicket.Operation)

    Params.Añadir (

    "prioridad", NewTicket.Priority)

    Params.Añadir (

    "tema", NewTicket.Subject)

    Params.Añadir (

    "descripción", NewTicket.Description)

    Params.Añadir (

    "categoría", NewTicket.Category)

    Params.Añadir (

    "nombre de usuario", NewTicket.Username)

    Params.Añadir (

    "logonDomainName", NewTicket.LogonDomainName)

    Params.Añadir (

    "contraseña", NewTicket.Password)

    Params.Añadir (

    "modo", "Sistema Generado")

    Oscuro responseArray Como Byte () = oWeb.UploadValues ​​(fullUrl, Params)

    MsgBox (System.Text.

    Codificación .ASCII.GetString (responseArray))



¿Su pregunta fue respondida aquí?
Consulte los otros módulos de preguntas frecuentes o puede ponerse en contacto con nuestro equipo de soporte en
servicedeskplus-support@manageengine.com

Confiado por las mejores organizaciones del mundo