Endpoint: Registrar Nova Conexão

Este endpoint é usado para registrar uma nova conexão. Antes de utilizar este endpoint, certifique-se de realizar o login e obter o token de gestão.

Requisição

        POST /tools/connections
    

Parâmetros de entrada

Parâmetro	Tipo	Descrição
name	string	O nome da nova conexão
webhookUrl	string	URL para receber mensagens e atualizações de informações da conexão

Headers

Além dos parâmetros de entrada, a requisição deve incluir os seguintes headers:

Header	Descrição
Content-Type	O tipo de conteúdo da requisição, deve ser "application/json"
Authorization	O token de autorização no formato "Bearer {token de gestão}

Exemplo de Requisição

                    
                        POST /tools/connections/ HTTP/1.1
                        Host: dev.solubot.com.br
                        Content-Type: application/json
                        Authorization: Bearer <token de gestão>
                        {
                            "name": "<nome da conexão>",
                            "webhookUrl": "<webhook da conexão>";
                        }
                    
                

Resposta de Sucesso

Em caso de sucesso, a requisição retornará o código de status 200 OK e os detalhes da nova conexão registrada no formato JSON.

                    
                        HTTP/1.1 200 OK
                        Content-Type: application/json

                        {
                            "id": <id da conexão>,
                            "name": <nome da conexão>,
                            "status": <status da conexão>,
                            "token": <token da conexão>,
                            "webhookUrl": <webhook da conexão>,
                            "createdAt": <data e hora de criação>,
                            "updatedAt": <data e hora de última atualização>
                        }
                    
                

Resposta de Erro

Em caso de falha na requisição, serão retornados códigos de status diferentes de 200. A resposta de erro pode conter informações adicionais no corpo da resposta.

Código	Mensagem	Descrição
400	CONNECTION_NAME_ALREADY_IN_USE	Já existe uma conexão com este nome.
401	ERR_SESSION_EXPIRED	A sessão foi expirada, necessário realizar login novamente.
401	ERR_NO_PERMISSION	O usuário não possui permissão para acessar a conexão.
403	INVALID_TOKEN	O token de autorização fornecido é inválido ou expirou. É necessário fornecer um token válido para acessar a conexão.

Uso da Requisição

1. O cliente envia uma requisição POST para /tools/connections/ para registrar uma nova conexão.
2. A requisição deve incluir o header "Content-Type" com o valor "application/json" e o header "Authorization" com o token de autorização no formato "Bearer {token de gestão}".
3. O servidor processa a requisição e registra uma nova conexão com o nome fornecido.
4. Em caso de sucesso, o servidor retorna o código de status 200 OK junto com os detalhes da nova conexão registrada no formato JSON.
5. Caso ocorra um erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.