Integración

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

POST /integration
Cuerpo de la solicitud
Respuestas
POST /integration/filter
Cuerpo de la solicitud
Respuestas
GET /integration?id={id}&isTemplates={isTemplates}
Parámetros
Respuestas
PUT /integration?id={id}&isTemplates={isTemplates}
Parámetros
Cuerpo de la Solicitud
Respuestas
PATCH /integration?id={id}&isTemplates={isTemplates}
Parámetros
Cuerpo de la solicitud
Respuestas
DELETE /integration?id={id}&isTemplates={isTemplates}
Parámetros
Respuestas

Operaciones sobre recursos de integración. 6 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado como se describe en Authentication.

POST /integration

Agregar una nueva integración a un nivel jerárquico específico

Cuerpo de la solicitud

Agregar Integración

json

{
  "name": "string (required)",
  "isActive": "boolean",
  "type": "string",
  "description": "string",
  "internalProxy": "string",
  "externalProxy": "string",
  "vpnProxy": "string",
  "protocolType": "string",
  "userName": "string",
  "password": "string",
  "accessToken": "string",
  "externalEndpoint": "string",
  "accessLevel": "string (required)",
  "entityId": "string (required)",
  "integrationInput": "object",
  "integrationOutput": "object"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "result": true
}

POST /integration/filter

Obtiene la lista de integraciones con filtrado, ordenación y paginación. Permite buscar por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario autenticado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.

Cuerpo de la solicitud

Filtrado y ordenación de Integración

json

{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "dataResult": [
    {
      "uniqueId": "644745a2be7af43fac26788f",
      "accessLevel": "serviceprovider",
      "isActive": true,
      "name": "Webhook For DEV",
      "description": "desc"
    },
    {
      "uniqueId": "6447481dbe7af43fac267891",
      "accessLevel": "serviceprovider",
      "isActive": true,
      "name": "DC09 For DEV"
    },
    {
      "uniqueId": "644748ecbe7af43fac267892",
      "accessLevel": "serviceprovider",
      "isActive": true,
      "name": "External Integration Test"
    }
  ],
  "totalRecordsCount": 3
}

GET /integration?id={id}&isTemplates={isTemplates}

Obtener Integración por Id

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	query	string	no
isTemplates	query	string	no

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "data": {
    "_id": "62ea2a8328c7c9",
    "uniqueId": "afd49a39338dc",
    "accessLevel": "site",
    "createdBy": "developer-1@dev.de",
    "createdOn": 1659513475763,
    "modifiedBy": "developer-1@dev.de",
    "modifiedOn": 1659514047995,
    "name": "External Integration",
    "description": "desc",
    "internalProxy": "",
    "externalProxy": "",
    "vpnProxy": "",
    "protocolType": "",
    "userName": "",
    "password": "",
    "accessToken": "",
    "externalEndpoint": "",
    "parentAccountId": "23424-324-3424",
    "integrationInput": {},
    "integrationOutput": {},
    "serviceProviderId": "",
    "customerId": "",
    "siteId": ""
  }
}

PUT /integration?id={id}&isTemplates={isTemplates}

Actualizar una Integración existente

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí

Cuerpo de la Solicitud

Para actualizar la integración, proporcione el Id existente

json

{
  "name": "string",
  "isActive": "boolean",
  "type": "string",
  "description": "string",
  "internalProxy": "string",
  "externalProxy": "string",
  "vpnProxy": "string",
  "protocolType": "string",
  "userName": "string",
  "password": "string",
  "accessToken": "string",
  "externalEndpoint": "string",
  "integrationInput": "object",
  "integrationOutput": "object"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "isSuccess": true
}

PATCH /integration?id={id}&isTemplates={isTemplates}

Parche para actualizar la integración

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	string	sí

Cuerpo de la solicitud

Para actualizar la integración

json

{
  "isActive": "boolean"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "isSuccess": true
}

DELETE /integration?id={id}&isTemplates={isTemplates}

Eliminar integración por Id

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	string	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
401	No autorizado
403	Prohibido
404	No Encontrado

Example 200 respuesta:

json

{
  "isSuccess": true
}

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.