APIs REST do SDK do Conector¶

Visão geral¶

Essas APIs estão disponíveis para registrar e gerenciar conectores criados com o SDK do conector. Exemplos de uso essas APIs com Postman são mostradas no Registro página.

URL base¶

Todas as APIs listadas abaixo usam um URL base composto por

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

onde

• {hostURL}: O URL do hospedar da região Jitterbit, como https://na-east.jitterbit.com

Prefacie cada URL fornecido para cada API com este URL base (representado por {baseURL}). Para determinar qual região onde sua organização está, consulte Encontrando minha região.

A URL do hospedar para cada região é fornecida por esta tabela:

Autenticação¶

Além do URL base, todas as APIs listadas abaixo — com exceção de Faça login no Harmony—suponha que um token de autenticação seja passado como um dos cabeçalhos na solicitação. Este token pode ser obtido usando a primeira API e extraindo o token de sua resposta.

Cabeçalhos de solicitação¶

Com exceção de Fazer login no Harmony, todas as APIs listadas abaixo são para incluir esses cabeçalhos de solicitação (além de quaisquer cabeçalhos descritos para uma API específica):

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

onde

• authToken: Token de autorização obtido de logando no Harmony

Faça login no Harmony¶

Faz login no Harmony. Use esta API para obter o token de autenticação necessário para usar as outras APIs listadas nesta página.

PUT {baseURL}/user/login

onde

• {baseURL}: O URL base, como descrito acima

Cabeçalhos de solicitação¶

• Content-Type: application/json

Corpo da Solicitação¶

O corpo da solicitação deve conter:

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

onde

• {email}: O nome de usuário (endereço e-mail ) associado ao login do Harmony
• {password}: A senha para o nome de usuário

Resposta¶

O corpo da resposta será uma string JSON contendo um authenticationToken. Este token deve ser passado como o authToken cabeçalho das chamadas de API subsequentes e autenticará essas chamadas.

Registrar um conector personalizado¶

Registra um conector e obtém os IDs necessários para o arquivo de manifesto do conector. Execute esta API antes para empacotar o arquivo JAR do conector.

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

onde

• {baseURL}: O URL base, como descrito acima
• {orgId}: ID da organização da organização Harmony na qual o conector está registrado

Cabeçalhos de solicitação¶

• authToken: Token de autorização obtido de logando no Harmony

Corpo da solicitação¶

O corpo da solicitação deve conter:

{
    "name": "{connectorName}",
    "version": "{connectorVersion}"
}

• {connectorName}: O nome do conector
• {connectorVersion}: A versão do conector

Resposta¶

O corpo da resposta conterá uma string JSON com os IDs, a chave e o segredo necessários para o conector arquivo de manifesto. Por exemplo:

{
    "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 os conectores personalizados (aqueles criados com o Connector SDK ou o Connector Builder) registrados com um determinada organização.

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

onde

• {baseURL}: O URL base, como descrito acima
• {orgId}: ID da organização da organização Harmony na qual o conector está registrado

Cabeçalhos de solicitação¶

• authToken: Token de autorização obtido de logando no Harmony

Resposta¶

O corpo da resposta conterá uma string JSON com uma lista de conectores registrados. Este exemplo mostra uma organização com o exemplo de conector do 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"
        }
    ]
}

Excluir um registro de conector¶

Exclui o registro de um conector personalizado. Esta API terá sucesso apenas se o conector não for usado em nenhum projetos na organização. Para excluir a payload JSON (o arquivo JSON que descreve a IU, fornecido no manifesto entrada Jitterbit-Connector-UI) de um conector personalizado, use a API para excluir uma payload do conector.

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

onde

• {baseURL}: O URL base, como descrito acima
• {orgId}: ID da organização da organização Harmony na qual o conector está registrado
• {connectorId}: ID do conector, obtido quando o conector foi registrado

Cabeçalhos de solicitação¶

• authToken: Token de autorização obtido de logando no Harmony

Excluir uma carga útil do conector¶

Exclui a payload JSON (o arquivo JSON que descreve a IU, fornecido na entrada do manifesto Jitterbit-Connector-UI) de um conector personalizado. A payload é armazenada em cache no Harmony para renderizar a IU do Integration Studio do conector. Essa API terá êxito apenas se o conector não for usado em nenhum projeto da organização. Deletar o registro de um conector personalizado, use a API para excluir um registro de conector.

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

onde

• {baseURL}: O URL base, como descrito acima
• {orgId}: ID da organização da organização Harmony na qual o conector está registrado
• {connectorId}: ID do conector, obtido quando o conector foi registrado

Cabeçalhos de solicitação¶

• authToken: Token de autorização obtido de logando no Harmony

Validar uma chave e um segredo do conector¶

Valida uma chave de conector e um par secreto.

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

onde

• {baseURL}: O URL base, como descrito acima
• {orgId}: ID da organização da organização Harmony na qual o conector está registrado

Cabeçalhos de solicitação¶

• authToken: Token de autorização obtido de logando no Harmony

Corpo da solicitação¶

O corpo da solicitação deve conter:

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

onde

• {connectorName}: O nome do conector
• {key}: A chave associada ao conector desse nome
• {secret}: O segredo associado ao conector desse nome