dev.Solubot Documentação

Endpoint: Excluir Conexão

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

Requisição

        DELETE /tools/connections/{id}
    

Parâmetros de entrada

Parâmetro Tipo Descrição
id string O número da conexão a ser excluída

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

        
            DELETE /tools/connections/{id} HTTP/1.1
            Host: dev.solubot.com.br
            Content-Type: application/json
            Authorization: Bearer <token de gestão>
        
    

Resposta de Sucesso

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

            {
              "message": "CONNECTION_DELETED"
            }
        
    

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. Os possíveis erros são:

Código Mensagem Descrição
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.
404 ERR_NO_CONNECTION_FOUND Nenhuma conexão encontrada com o ID fornecido.

Uso da Requisição

  1. O cliente envia uma requisição DELETE para /tools/connections/{id} para excluir uma conexão específica.
  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 exclui a conexão correspondente ao ID fornecido.
  4. Em caso de sucesso, o servidor retorna o código de status 200 OK.
  5. Caso ocorra um erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.