> For the complete documentation index, see [llms.txt](https://docs.skyone.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skyone.cloud/skyone-studio/modulos/configuracoes-and-operacoes/configuracoes-de-modulos/conectividade-rest.md).
# Conectividade: REST
### Visão Geral
A conectividade **REST** pode ser utilizada com serviços web que utilizem APIs REST, tais como SAP Business One, Zoho CRM, iugu e Google Fit.
Se o sistema já possuir uma API, o **Skyone Studio** poderá usá-la diretamente, adicionando controles de *rate limit* e segurança, o que facilita a sua integração com outros produtos.
o **Skyone Studio** trabalha com o formato JSON, permitindo os seguintes métodos de requisição HTTP:
* POST
* GET
* UPDATE
* DELETE
* PATCH
***
### **Tipos de autenticação**
Se você escolher o tipo de conectividade **REST**, terá as seguintes opções de **Tipo de autenticação**:
* **No Auth**: conexão aberta, sem nenhum tipo de autenticação;
* **Basic**: conexão simples, com usuário e senha;
* **Bearer Token**: conexão que requer token no formato JSON Web Token (JWT) ou outro desejado;
* **OAuth 1**: conexão com autenticação no padrão OAuth 1.0;
* **OAuth 2**: conexão com autenticação no padrão OAuth 2.0;
* **Cookie**: conexão que usa cookies para autenticar requisições de clientes e armazenar as informações de uma sessão de usuário;
* **AWS**: conexão com autenticação HMAC, que permite acessar os serviços AWS;
* **OAuth2 JWT**: conexão com autenticação no padrão OAuth 2.0 e que utiliza token JWT;
* **Header Authentication:** uso de informações de cabeçalho (headers) em uma solicitação;
* **Certificado CA**: conexão que utiliza certificados digitais emitidos por uma Autoridade Certificadora (CA) para validar a identidade e garantir a segurança da comunicação.
* **mTLS**: conexão que adota autenticação mútua TLS, onde tanto o cliente quanto o servidor precisam apresentar certificados válidos para estabelecer a comunicação de forma segura.
***
#### Como conectar uma conta
Após a definição do tipo de conectividade, o próximo passo consiste em escolher o **tipo de autenticação**. Somente após dessas definições é que você poderá adicionar uma nova conta, além de poder selecionar, editar ou remover uma das contas previamente cadastradas.
Para adicionar uma conta conectada, clique em "**Conta conectada"** e, em seguida, "**Adicionar conta conectada".**
Para seguir com a configuração, clique na aba do **tipo de autenticação** escolhido:
{% hint style="warning" %}
Importante: atente-se ao campo “**Host**” da configuração da **Conta Conectada**, pois os dados serão concatenados com as configuração de operações.
{% endhint %}
No Auth
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Terminal** (opcional): caso tenha um terminal configurado, selecione-o para que a conexão seja feita através do "**Agente"** correspondente;
2. **Nome da conta:** nome da conta cadastrada;
3. **Host:** endereço IP da API;
4. **Porta:** número da porta da API.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
Basic
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Terminal** (opcional): caso tenha um terminal configurado, selecione-o para que a conexão seja feita através do "**Agente"** correspondente;
2. **Nome da conta**: nome da conta cadastrada;
3. **Host:** endereço IP da API;
4. **Porta:** número da porta da API;
5. **Usuário;**
6. **Senha.**
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos
Bearer Token
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Terminal** (opcional): caso tenha um terminal configurado, selecione-o para que a conexão seja feita através do "**Agente"** correspondente;
2. **Nome da conta:** nome da conta cadastrada;
3. **Host:** endereço IP da API;
4. **Porta:** número da porta da API;
5. **Token:** token criado.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
OAuth 1
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Terminal** (opcional): caso tenha um terminal configurado, selecione-o para que a conexão seja feita através do "**Agente"** correspondente;
2. **Nome da conta:** nome da conta cadastrada
3. **Host:** endereço IP da API
4. **Porta:** número da porta da API
5. **Customer Key:** usuário necessário para a autenticação
6. **Customer Secret:** senha necessária para a autenticação
7. **Access token:** token utilizado para acessar uma API
8. **Token secret:** token obtido para conceder um novo access token sem que o usuário precise se logar novamente
9. **Método de assinatura:** técnica de segurança que utiliza HMAC-SHA1 para garantir a autenticidade.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
OAuth 2
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Nome da conta**: nome da conta cadastrada
2. **Host**: endereço IP da API
3. **Porta**: número da porta da API
4. **Client ID**: usuário necessário para a autenticação
5. **Client Secret**: senha necessária para a autenticação
6. **Access token**: token utilizado para acessar uma API
7. **Refresh token**: token obtido para conceder um novo *access token* sem que o usuário precise se logar novamente
8. **Endpoint de troca de token**: URL utilizada para obter tokens para autorizar usuários
9. **Content type:** formato de dados que será transmitido na requisição. Por padrão, é no formato JSON, podendo ser alterado para o URL Encoded.
**Parâmetros do payload do token:**
* **Chave:** identificador ou nome associado a uma determinada informação do payload do token.
* **Valor:** dado associado à chave, contextualizando as informações da autenticação já inseridas anteriormente.
**Parâmetros do header do token:**
* **Chave da resposta com o token:** chave do JSON que irá retornar a informação do token no body. Por padrão, é o Access Token (neste caso, não é preciso inserir no campo), porém nos casos em que será outro (Zoho Token, por exemplo) é preciso especificá-lo.
* **Chave da resposta com o refresh token:** chave do JSON que irá retornar a informação do Refresh Token no body.
* **Enviar parâmetros de troca de token como query string**: se selecionado, faz com que os parâmetros do Refresh Token sejam enviados como query string
**Parâmetros no cabeçalho da requisição após autenticação:**
* **Chave:** Nome do parâmetro que será enviado na chamada GET Clientes em um Resource Server. Por exemplo: Authorization.
* **Valor:** Dado associado que será necessário para transmitir ou autenticar o acesso. Por exemplo: Bearer <>token\
* **Usar conta em mTLS**: Ao habilitar esta opção, você poderá selecionar uma conta previamente configurada. Caso ainda não tenha configurado, consulte as instruções de cadastro na seção [mTLS](#mtls) logo abaixo.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
Cookie
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Terminal** (opcional): caso tenha um terminal configurado, selecione-o para que a conexão seja feita através do "**Agente"** correspondente;
2. **Nome da conta:** nome da conta cadastrada;
3. **Host:** endereço IP da API;
4. **Porta:** número da porta da API;
5. **Endpoint de autenticação:** URL utilizada para autenticação do usuário;
6. **Cookie** (opcional): conteúdo do cookie
7. **Body** (opcional) **:** conteúdo do corpo da requisição necessário para gerar o cookie.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
AWS
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
1. **Nome da conta:** nome da conta cadastrada;
2. **Host:** endereço IP da API;
3. **Porta:** número da porta da API;
4. **AWS Access Key ID:** usuário da conta AWS;
5. **AWS Secret Access Key:** senha da conta AWS;
6. **Serviço AWS :** Serviço da AWS que deseja utilizar. Exemplos: s3, ses, ecs2;
7. **Região AWS:** região, dentro da nomenclatura da AWS. Exemplos: us-east-1, ap-southeast-1.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
OAuth2 JWT
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
* **Nome da conta**: nome da conta cadastrada;
* **Host**: endereço IP da API;
* **Porta** (opcional): número da porta da API;
* **Private Key**: clique para carregar um arquivo de chave privada (.pem);
* **URL de autenticação**: URL para a solicitação do token de autenticação;
* **Tempo de expiração .JWT (s)**: tempo antes que o token JWT expire (em segundos)
* **Content type:** formato de dados que será transmitido na requisição. Por padrão, é no formato JSON, podendo ser alterado para o URL Encoded.
* **Parâmetros no payload JWT** - parâmetros que podem ser informados (campos **CHAVE** e **VALOR**):
* **iss (issuer)**: emissor do token
* **aud (audience)**: destinatário do token, representa a aplicação que irá usá-lo
* **scope**: escopo de dados requisitados
* **Parâmetros no corpo da requisição do token** - parâmetros que podem ser informados (campos **CHAVE** e **VALOR**):
* **authorization**: informe aqui o valor do token de autorização
* **Chave da resposta:** token
* **Parâmetros no cabeçalho da requisição após autenticação** - parâmetros que podem ser informados (campos **CHAVE** e **VALOR**):
* **authorization**: informe aqui o valor do token de autorização
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos.
Header Authentication
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
* **Nome da conta**: nome da conta cadastrada;
* **Host**: endereço IP da API;
* **Porta** (opcional): número da porta da API;
**Opções do header:**
* **Chave:** Nome do parâmetro que será enviado.
* **Valor:** Dado associado que será necessário para transmitir ou autenticar o acesso.
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos
Certificado CA
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
* **Nome da conta**: nome da conta cadastrada;
* **Host**: endereço IP da API;
* **Porta** (opcional): número da porta da API;
* Adicione o **Certificado CA**
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos
mTLS
Ao escolher a opção "**Adicionar conta conectada**", o seguinte modal será apresentado:
Preencha os dados, sendo que:
**Nome da conta**: nome da conta cadastrada
**Host**: endereço IP da API
**Porta**: número da porta da API
**Certificado do client:** upload do certificado do cliente, assinado pela CA (arquivo .crt)
**Chave privada do client**: upload da chave privada correspondente ao certificado do cliente (arquivo .key)
**Certificado intermediário**: upload do certificado da CA raiz ou intermediária que assinou o certificado do servidor (arquivo .crt).
Após preencher os dados, clique em "**Criar conta**".
Pronto! Sua conta conectada está criada e poderá ser utilizada por outros módulos e fluxos, aparecendo entre as opções de contas configuradas em ambos os casos
Para finalizar, clique em "**Salvar alterações"** para definir as configurações do seu módulo.
{% hint style="warning" %}
Importante: após salvar as alterações, não será possível mais alterar o Tipo de conectividade e/ou Tipo de autenticação.
{% endhint %}
Próximo passo: [Crie operações para o módulo](/skyone-studio/modulos/configuracoes-and-operacoes/operacoes-de-modulos.md)
Leia também:
[Gestão das contas conectadas](/skyone-studio/modulos/configuracoes-and-operacoes/configuracoes-de-modulos/gestao-das-contas-conectadas.md)
[Consolidação de output de módulos REST](/skyone-studio/how-to/consolidacao-de-output-de-modulo-rest.md)
[Como utilizar o Proxy para Data Engine](/skyone-studio/data-management/engine/como-utilizar-o-proxy-para-data-engine.md)
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.skyone.cloud/skyone-studio/modulos/configuracoes-and-operacoes/configuracoes-de-modulos/conectividade-rest.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.