API REST del SDK de Conectores
Descripción general
Estas API están disponibles para registrar y gestionar conectores creados con el SDK de Conectores. Ejemplos de uso de estas API con Postman se muestran en la página de Registro.
Método | Descripción |
---|---|
Iniciar sesión de usuario | Iniciar sesión en Harmony |
Registrar un conector | Registrar un conector personalizado |
Listar conectores registrados | Listar conectores registrados |
Eliminar registro | Eliminar un registro de conector |
Eliminar carga útil | Eliminar una carga útil de conector |
Validar clave/secreto de conector | Validar una clave y secreto de conector |
Nota
Para eliminar completamente un conector de una organización, es necesario eliminar tanto el registro como la carga útil JSON. Solo se pueden eliminar aquellos conectores que no se utilizan en ningún proyecto de la organización.
URL base
Todas las API enumeradas a continuación utilizan una URL base compuesta por
{hostURL}/jitterbit-cloud-restful-service/
donde
{hostURL}
: La URL del host de la región de Jitterbit, comohttps://na-east.jitterbit.com
Antepon cada URL dada para cada API con esta URL base (representada por {baseURL}
). Para determinar en qué región
se encuentra tu organización, consulta Encontrar mi región.
La URL del host para cada región se proporciona en esta tabla:
Región | URL del host |
---|---|
NA | https://na-east.jitterbit.com |
EMEA | https://emea-west.jitterbit.com |
APAC | https://apac-southeast.jitterbit.com |
Autenticación
Además de la URL base, todas las API listadas a continuación---con la excepción de Iniciar sesión en Harmony---asumen que se pasa un token de autenticación como uno de los encabezados en la solicitud. Este token se puede obtener utilizando la primera API y extrayendo el token de su respuesta.
Encabezados de solicitud
Con la excepción de Iniciar sesión en Harmony, todas las API listadas a continuación deben incluir estos encabezados de solicitud (además de cualquier encabezado descrito para una API en particular):
Content-Type: application/json
authToken: {authToken}
donde
authToken
: Token de autorización obtenido de iniciar sesión en Harmony
Iniciar sesión en Harmony
Inicia sesión en Harmony. Utiliza esta API para obtener el token de autenticación necesario para usar las otras API listadas en esta página.
PUT {baseURL}/user/login
donde
{baseURL}
: La URL base, como se describe arriba
Encabezados de solicitud
Content-Type: application/json
Cuerpo de la solicitud
El cuerpo de la solicitud debe contener:
{
"email": "{email}",
"password": "{password}"
}
donde
{email}
: El nombre de usuario (dirección de correo electrónico) asociado con el inicio de sesión en Harmony{password}
: La contraseña para el nombre de usuario
Respuesta
El cuerpo de la respuesta será una cadena JSON que contiene un authenticationToken
. Este token debe ser pasado como
el encabezado authToken
de las llamadas API subsiguientes y autentificará esas llamadas.
Registrar un conector personalizado
Registra un conector y obtiene los IDs requeridos para el archivo de manifiesto del conector. Ejecuta esta API antes de empaquetar el archivo JAR del conector.
POST {baseURL}/orgs/{orgId}/connector
donde
{baseURL}
: La URL base, como se describe arriba{orgId}
: ID de la organización de la organización Harmony en la que se registra el conector
Encabezados de solicitud
authToken
: Token de autorización obtenido de iniciar sesión en Harmony
Cuerpo de la solicitud
El cuerpo de la solicitud debe contener:
{
"name": "{connectorName}",
"version": "{connectorVersion}"
}
{connectorName}
: El nombre del conector{connectorVersion}
: La versión del conector
Respuesta
El cuerpo de la respuesta contendrá una cadena JSON con los IDs, clave y secreto requeridos para el archivo de manifiesto del conector. Por ejemplo:
{
"status": true,
"operation": "Register a connector",
"id": "4471",
"key": "6d093654-d...2-10cad6797d6e",
"secret": "3673e11b-f...d-5e3f3ad796d5",
"endpointEntityId": "2370701",
"functionEntityStartId": "2370702",
"functionEntityEndId": "2370800"
}
Listar conectores registrados
Lista todos los conectores personalizados (aquellos creados con el SDK de Conectores o el Constructor de Conectores) registrados en una organización particular.
GET {baseURL}/orgs/{orgId}/connector
donde
{baseURL}
: La URL base, como se describe arriba{orgId}
: ID de la organización de la organización Harmony en la que el conector está registrado
Encabezados de la solicitud
authToken
: Token de autorización obtenido de iniciar sesión en Harmony
Respuesta
El cuerpo de la respuesta contendrá una cadena JSON con una lista de conectores registrados. Este ejemplo muestra una organización con el conector de Dropbox registrado:
{
"status": true,
"operation": "List registered connectors",
"registeredConnectorList": [
{
"id": "4471",
"name": "Dropbox",
"version": "1.0.0",
"key": "6d093654-d...2-10cad6797d6e",
"secret": "3673e11b-f...d-5e3f3ad796d5",
"endpointEntityId": "2370701",
"functionEntityStartId": "2370702",
"functionEntityEndId": "2370800"
}
]
}
Eliminar un registro de conector
Elimina el registro de un conector personalizado. Esta API solo tendrá éxito si el conector no se utiliza en ningún proyecto de la organización. Para eliminar la carga útil JSON (el archivo JSON que describe la interfaz de usuario, dado en la entrada del manifiesto Jitterbit-Connector-UI
) de un conector personalizado, utiliza la API para
eliminar una carga útil de conector.
DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}
donde
{baseURL}
: La URL base, como se describe arriba{orgId}
: ID de la organización de la organización Harmony en la que el conector está registrado{connectorId}
: ID del conector, obtenido cuando se registró el conector
Encabezados de la solicitud
authToken
: Token de autorización obtenido de iniciar sesión en Harmony
Eliminar la carga útil de un conector
Elimina la carga útil JSON (el archivo JSON que describe la interfaz de usuario, dado en la entrada del manifiesto Jitterbit-Connector-UI
) de un conector personalizado. La carga útil se almacena en caché en Harmony para renderizar la interfaz de usuario del Integration Studio del conector. Esta API solo tendrá éxito si el conector no se utiliza en ningún proyecto de la organización. Para eliminar el registro de un conector personalizado, utiliza la API para
eliminar un registro de conector.
DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}/sdk/delete
donde
{baseURL}
: La URL base, como se describe arriba{orgId}
: ID de la organización de la organización Harmony en la que está registrado el conector{connectorId}
: ID del conector, obtenido cuando se registró el conector
Encabezados de la solicitud
authToken
: Token de autorización obtenido de iniciar sesión en Harmony
Validar una clave y secreto de conector
Valida un par de clave y secreto de conector.
PUT {baseURL}/orgs/{orgId}/connector/validate/securityinfo
donde
{baseURL}
: La URL base, como se describe arriba{orgId}
: ID de la organización de la organización Harmony en la que está registrado el conector
Encabezados de la solicitud
authToken
: Token de autorización obtenido de iniciar sesión en Harmony
Cuerpo de la solicitud
El cuerpo de la solicitud debe contener:
{
"name": "{connectorName}",
"key": "{key}",
"secret": "{secret}"
}
donde
{connectorName}
: El nombre del conector{key}
: La clave asociada con el conector de ese nombre{secret}
: El secreto asociado con el conector de ese nombre