Connector SDK REST APIs
Visão Geral
Essas APIs estão disponíveis para registrar e gerenciar conectores criados com o Connector SDK. Exemplos de uso dessas APIs com o Postman são mostrados na página de Registro.
Método | Descrição |
---|---|
Logar Usuário | Logar no Harmony |
Registrar um Conector | Registrar um conector personalizado |
Listar Conectores Registrados | Listar conectores registrados |
Deletar Registro | Deletar um registro de conector |
Deletar Payload | Deletar um payload de conector |
Validar Chave/Segredo do Conector | Validar uma chave e segredo de conector |
Nota
Para deletar completamente um conector de uma organização, é necessário deletar tanto o registro quanto o payload JSON. Você pode deletar apenas aqueles conectores que não estão sendo usados em nenhum projeto da organização.
URL Base
Todas as APIs listadas abaixo usam uma URL base composta por
{hostURL}/jitterbit-cloud-restful-service/
onde
{hostURL}
: A URL do host da região Jitterbit, comohttps://na-east.jitterbit.com
Prefacie cada URL dada para cada API com esta URL base (representada por {baseURL}
). Para determinar em qual região
sua organização está, consulte Encontrando Minha Região.
A URL do host para cada região é dada por esta tabela:
Região | URL do Host |
---|---|
NA | https://na-east.jitterbit.com |
EMEA | https://emea-west.jitterbit.com |
APAC | https://apac-southeast.jitterbit.com |
Autenticação
Além da URL Base, todas as APIs listadas abaixo---com exceção de Logar no Harmony---assumem que um token de autenticação é 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 da solicitação
Com exceção de Logar no Harmony, todas as APIs listadas abaixo devem incluir estes 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 ao logar no Harmony
Logar 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}
: A URL base, conforme descrito acima
Cabeçalhos da 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 de email) associado ao login no 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 cabeçalho authToken
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 de empacotar o arquivo JAR do conector.
POST {baseURL}/orgs/{orgId}/connector
onde
{baseURL}
: A URL base, conforme descrito acima{orgId}
: ID da organização do org do Harmony em que o conector está registrado
Cabeçalhos da solicitação
authToken
: Token de autorização obtido ao logar 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, chave e segredo necessários para o arquivo de manifesto do conector. 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 SDK de Conector ou o Conector Builder) registrados em uma organização específica.
GET {baseURL}/orgs/{orgId}/connector
onde
{baseURL}
: A URL base, conforme descrito acima{orgId}
: ID da organização da org Harmony na qual o conector está registrado
Cabeçalhos da Solicitação
authToken
: Token de autorização obtido ao fazer login no Harmony
Resposta
O corpo da resposta conterá uma string JSON com uma lista de conectores registrados. Este exemplo mostra uma org com o conector Dropbox de exemplo 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 estiver sendo usado em nenhum
projeto na organização. Para excluir a carga útil JSON (o arquivo JSON que descreve a interface do usuário, dado na entrada do manifesto Jitterbit-Connector-UI
) de um conector personalizado, use a API para
excluir uma carga útil de conector.
DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}
onde
{baseURL}
: A URL base, conforme descrito acima{orgId}
: ID da organização da org Harmony na qual o conector está registrado{connectorId}
: ID do conector, obtido quando o conector foi registrado
Cabeçalhos da Solicitação
authToken
: Token de autorização obtido ao fazer login no Harmony
Excluir um payload de conector
Exclui o payload JSON (o arquivo JSON que descreve a interface do usuário, fornecido na entrada do manifesto Jitterbit-Connector-UI
) de um conector personalizado. O payload é armazenado em cache no Harmony para renderizar a interface do usuário do Integration Studio do conector. Esta API terá sucesso apenas se o conector não estiver sendo usado em nenhum projeto na organização. Para excluir 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}
: A URL base, conforme 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 da solicitação
authToken
: Token de autorização obtido ao fazer login no Harmony
Validar uma chave e segredo de conector
Valida um par de chave e segredo de conector.
PUT {baseURL}/orgs/{orgId}/connector/validate/securityinfo
onde
{baseURL}
: A URL base, conforme descrito acima{orgId}
: ID da organização da organização Harmony na qual o conector está registrado
Cabeçalhos da solicitação
authToken
: Token de autorização obtido ao fazer login 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