APIs REST del SDK del Conector¶

Descripción General¶

Estas APIs están disponibles para registrar y administrar conectores creados con Connector SDK. Ejemplos de uso estas APIs con Postman se muestran en el Registro página.

URL Base¶

Todas las APIs enumeradas a continuación utilizan una URL base compuesta por

{hostURL}/jitterbit-cloud-restful-service/

dónde

• {hostURL}: La URL del alojar de la región de Jitterbit, como https://na-east.jitterbit.com

Preceda cada URL proporcionada para cada API con esta URL base (representada por {baseURL}). Para determinar qué región en la que se encuentra su organización, consulte Buscar mi región.

La URL del alojar para cada región viene dada por esta tabla:

Autenticación¶

Además de la URL base, todas las APIs enumeradas a continuación — con la excepción de Inicia sesión en Harmony—suponga que un token de autenticación se pasa como uno de los encabezados en la solicitud. Este token se puede obtener usando 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 APIs enumeradas a continuación son para incluir estos encabezados de solicitud (además de los encabezados descritos para una API en particular):

Content-Type: application/json
authToken: {authToken}

dónde

• authToken: Token de autorización obtenido al iniciar sesión en Harmony

Inicie Sesión en Harmony¶

Inicia sesión en Harmony. Use esta API para obtener el token de autenticación necesario para usar las otras APIs enumeradas en esta página.

PUT {baseURL}/user/login

dónde

• {baseURL}: La URL base, como descrito anteriormente

Encabezados de Solicitud¶

• Content-Type: application/json

Cuerpo de Solicitud¶

El cuerpo de la solicitud debe contener:

{
  "email": "{email}",
  "password": "{password}"
}

dónde

• {email}: El nombre de usuario (dirección de correo ) asociado con el inicio de sesión de 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 pasarse como el authToken encabezado de llamadas API subsiguientes y autenticará esas llamadas.

Registrar un Conector Personalizado¶

Registra un conector y obtiene los ID necesarios para el archivo de manifiesto del conector. Ejecute esta API antes para empaquetar el archivo JAR del conector.

POST {baseURL}/orgs/{orgId}/connector

dónde

• {baseURL}: La URL base, como descrito anteriormente
• {orgId}: ID de organización de la organización de Harmony en la que está registrado el conector

Encabezados de Solicitud¶

• authToken: Token de autorización obtenido al iniciar sesión en Harmony

Cuerpo de 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 ID, la clave y el secreto necesarios para el conector. archivo de manifiesto. 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"
}

Lista de Conectores Registrados¶

Enumera todos los conectores personalizados (aquellos creados con Connector SDK o Connector Builder) registrados con un organización particular.

GET {baseURL}/orgs/{orgId}/connector

dónde

• {baseURL}: La URL base, como descrito anteriormente
• {orgId}: ID de organización de la organización de Harmony en la que está registrado el conector

Encabezados de Solicitud¶

• authToken: Token de autorización obtenido al 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 de ejemplo 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 tendrá éxito solo si el conector no se usa en ningún proyectos en la organización. Para eliminar la carga útil de JSON (el archivo JSON que describe la interfaz de usuario, proporcionado en el manifiesto entrada Jitterbit-Connector-UI) de un conector personalizado, utilice la API para eliminar una carga útil del conector.

DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}

dónde

• {baseURL}: La URL base, como descrito anteriormente
• {orgId}: ID de organización de la organización de Harmony en la que está registrado el conector
• {connectorId}: ID del conector, obtenido cuando se registró el conector

Encabezados de Solicitud¶

• authToken: Token de autorización obtenido al iniciar sesión en Harmony

Eliminar una Carga Útil del Conector¶

Elimina la carga útil de JSON (el archivo JSON que describe la interfaz de usuario, proporcionado en la entrada del manifiesto Jitterbit-Connector-UI) de un conector personalizado. La carga útil se almacena en caché en Harmony para representar la interfaz de usuario de Cloud Studio del conector Esta API tendrá éxito solo si el conector no se usa en ningún proyecto de la organización. Borrar el registro de un conector personalizado, use la API para eliminar el registro de un conector.

DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}/sdk/delete

dónde

• {baseURL}: La URL base, como descrito anteriormente
• {orgId}: ID de organización de la organización de Harmony en la que está registrado el conector
• {connectorId}: ID del conector, obtenido cuando se registró el conector

Encabezados de Solicitud¶

• authToken: Token de autorización obtenido al iniciar sesión en Harmony

Validar una Clave y un Secreto de Conector¶

Valida una clave de conector y un par secreto.

PUT {baseURL}/orgs/{orgId}/connector/validate/securityinfo

dónde

• {baseURL}: La URL base, como descrito anteriormente
• {orgId}: ID de organización de la organización de Harmony en la que está registrado el conector

Encabezados de Solicitud¶

• authToken: Token de autorización obtenido al iniciar sesión en Harmony

Cuerpo de Solicitud¶

El cuerpo de la solicitud debe contener:

{
    "name": "{connectorName}",
    "key": "{key}",
    "secret": "{secret}"
}

dónde

• {connectorName}: El nombre del conector
• {key}: La clave asociada al conector de ese nombre
• {secret}: El secreto asociado con el conector de ese nombre