Como criar seu conector a partir de uma definição de API

Criar novo conector

Se você selecionar Iniciar a partir de uma definição de API, deverá fornecer a definição da API:
- De um arquivo local - Carregue uma coleção do Postman ou Swagger.
- De uma URL – Insira uma URL de arquivo, como https://petstore.swagger.io/v2/swagger.json.
Clique em Continuar.

Configurar seu conector

Na janela Confirmar importação, você pode:
- Altere o Nome do provedor, Nome do aplicativo e Nome do conector.
- Modifique os recursos que você deseja usar em seu conector personalizado. Todos os recursos disponíveis são selecionados automaticamente; desmarque aqueles que você deseja excluir.
  - Use a barra Pesquisar para procurar um recurso específico.
- Clique em Criar.
A janela Configurações agora é exibida.
Na guia Informações, você pode configurar os seguintes campos:
- Prefixo do conector - por exemplo, documentation. Isso é refletido na chave do seu conector.
- Nome do provedor – Insira um nome de provedor.
- Nome do aplicativo – Insira um nome de aplicativo.
- Tipo de API – Esse campo é desabilitado por padrão, pois, apenas REST é compatível no momento.
- Nome de exibição - esse é o nome do seu conector e ele aparecerá no catálogo de Conectores.
- Descrição – Insira uma descrição para seu conector.
- Ícone - Clique em Procurar para carregar uma imagem do seu computador.
Visualização do catálogo exibe como seu conector personalizado aparecerá no catálogo de conectores do Integration Service.
Clique em Salvar.

Configurar a API base

Na guia API base , configure a URL base para a API e a paginação do aplicativo:

URL base — Preenchido automaticamente com o valor declarado na criação do conector.
Tipo de paginação - As opções disponíveis no menu suspenso são: Página começa com 1, Página começa com 0, Deslocamento, Personalizado. Se a documentação do fornecedor não mostrar detalhes sobre a paginação, mantenha o valor padrão.
Máx. de paginação — O valor padrão é 100. Se a documentação do fornecedor não mostrar detalhes sobre a paginação, mantenha o valor padrão.
Cabeçalho do tipo conteúdo – Esse campo fica desabilitado por padrão, pois, apenas application/json é compatível no momento.
Aceitar cabeçalho – Esse campo fica desabilitado por padrão, pois, apenas application/json é compatível no momento.

Definir o método de autenticação

Na guia Autenticação , você configura o tipo de autenticação para o seu conector. Consulte mais informações sobre as opções suportadas em Tipos de autenticação.

Teste sua conexão

Depois de concluir a configuração da autenticação, selecione Adicionar conexão no menu suspenso:

Se sua conexão for bem-sucedida, o status será atualizado para Conectado.

Recursos

O Construtor de Conector gera a lista de recursos com base na definição da API fornecida. O menu do lado esquerdo exibe a lista de recursos disponíveis, organizados em grupos.

Clique no link Mais opções para configurar cada método. Você pode:
- Método Adicionar — Abre a janela Criar novo recurso .
- Permitir exclusão do método - Ativa um ícone Excluir para cada recurso no grupo.
- Editar caminho – Editar o caminho do recurso. Por exemplo: [BASE URL]/pet = https://petstore.swagger.io/v2/pet
- Excluir - Exclui um grupo de recursos. Uma mensagem avisa que a operação não pode ser desfeita.
- Duplicar - Abre a janela Duplicar recurso , onde você pode editar o Caminho, escolher um Nome de Exibição e Selecionar métodos.
Você também pode Criar novo grupo de recursos de duas maneiras:
- de Em branco
- do cURL
Se você escolher configurar um novo recurso a partir de Em branco, configure os seguintes campos:
- Caminho - [Base URL]/[path]
- Nome de exibição
- Selecionar métodos: Obter, Obter por Id, Postar, Colocar, Patch, Excluir
Se você optar por configurar um novo recurso a partir do cURL, insira um comando cURL.

Configure seus recursos

Ao selecionar um recurso, a seguinte janela é exibida:

Dependendo do método de recurso selecionado, as seguintes guias de configuração estarão disponíveis: Parâmetros, Campos de resposta/solicitação, Paginação, Pesquisa.

Parâmetros

Por exemplo, todas as quatro guias estão disponíveis para métodos GET. Para métodos POST, você só pode ver as guias Parâmetros, Campos de Solicitação e Campos de Resposta.

Em Parâmetros é possível visualizar a lista de parâmetros disponíveis para o recurso selecionado, adicionar novos parâmetros ou importar parâmetros de um recurso existente.

Os parâmetros listados nesta tabela são aqueles que você usará no Studio ao construir automações usando seu conector personalizado.

O objeto Pet corresponde ao grupo de recursos Pet, e os campos disponíveis são aqueles definidos para o recurso GETBYID:

Campos de resposta e solicitação

Os campos Resposta e Solicitação para cada recurso são gerados automaticamente quando uma solicitação é enviada.

Em cada guia respectiva, você pode editar ou excluir qualquer campo. Se você clicar no ícone Editar , a seguinte janela de configuração é exibida:

Na aba de campos de resposta/solicitação , as seguintes opções também estão disponíveis:

Caixa de seleção Substituir ao enviar a solicitação — se selecionada, quando você executa um envio de Solicitação, a lista de campos é gerada novamente. Não selecione esta opção se você adicionou novos campos ao seu recurso.

Botão de opções adicionais :

Opção	O que faz
Atualizar chave raiz de resposta	Defina a chave de resposta ao lidar com arrays aninhados na resposta.
Excluir todos os campos do método	Exclui todos os campos para o método selecionado.
Gerar a partir da carga	Use um exemplo de carga na documentação do serviço ou uma chamada de API para gerar os campos do recurso.

Botão Adicionar linha - Adiciona novos campos ao recurso.

Clique no ícone Colunas visíveis para adicionar ou excluir colunas na tabela de campos.

Cada cor na coluna Métodos corresponde a um determinado método: Obter, Obter por ID, Postar, Colocar, Patch, Excluir.

Paginação

Habilite a paginação para um recurso se você espera uma resposta na forma de lista. Se habilitar a paginação, você também precisará definir a Chave raiz de resposta na guia de configuração, para listas aninhadas.