# REST API

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FJ3wGbcHA9IKUayluiPkd%2Fimage.png?alt=media&#x26;token=b4e23b1a-16d2-452b-937b-2d31835fe734" alt=""><figcaption><p>Parâmetros de configuração</p></figcaption></figure>

<table><thead><tr><th width="246">Campo</th><th width="128">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>Descrição</td><td>Campo de texto</td><td>Campo reservado para adicionar detalhes sobre o funcionamento do conector dentro do fluxo.</td></tr><tr><td>Conta de serviço</td><td>Seletor</td><td>Possibilita a seleção de uma conta de serviço do tipo Bearer Token e que concede acesso à administração dos dados na conta.</td></tr><tr><td>Path</td><td>Campo de texto</td><td>Refere-se à parte específica da URL que identifica um recurso ou endpoint.</td></tr><tr><td>Method</td><td>Seletor</td><td>Representa a ação que deve ser realizada no recurso identificado pelo caminho.</td></tr><tr><td>Corpo</td><td>Campo de texto</td><td>Opcional e presente em requisições como POST, PUT ou PATCH, o corpo contém os dados que estão sendo enviados ao servidor. </td></tr><tr><td>Additional Headers</td><td>Tabela de parâmetros</td><td>Os cabeçalhos adicionais referem-se a informações extra incluídas em uma requisição HTTP para fornecer detalhes específicos sobre a requisição.</td></tr><tr><td>Output path</td><td>Campo de texto</td><td>Refere-se a um caminho específico utilizado para a saída ou resposta do conector.</td></tr></tbody></table>
{% endtab %}

{% tab title="Payload" %}

### **Payload**

Ao final da execução, serão retornados os dados da resposta da requisição realizada para a URL informada no conector, além de dados adicionais na mensagem contendo metadados da requisição e a resposta do servidor por meio dos atributos `response` e `request`.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FHnM33ZRaESKLTQSfEJuM%2Fimage.png?alt=media&#x26;token=8b379d43-d687-4b9b-acc3-e9575cac6bbe" alt=""><figcaption><p>Exemplo de request</p></figcaption></figure>

<table data-column-title-hidden data-view="cards"><thead><tr><th>Atributo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>payload { }</strong></td><td>Conteúdo retornado pela requisição.</td></tr><tr><td><strong>response { }</strong></td><td>Contém detalhes da resposta, permitindo monitorar a integridade através do status ou mensagens de retorno.</td></tr><tr><td><strong>request { }</strong></td><td>Exibe detalhes da requisição como URL, método, parâmetros, entre outras informações.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
