Endpoint: Desconexão
Este endpoint é usado para desconectar uma conexão específica.
Requisição
DELETE /connection/{id}
Parâmetros de entrada
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string | O número da conexão a ser desconectada |
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 da conexão no formato "Bearer {token da conexão}" |
Exemplo de Requisição
DELETE /connection/{id} HTTP/1.1
Host: dev.solubot.com.br
Content-Type: application/json
Authorization: Bearer <token da conexão>
Resposta de Sucesso
Em caso de sucesso, a requisição retornará o código de status 200 OK. Nenhum conteúdo adicional é retornado.
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_NO_PERMISSION | O usuário não possui permissão para acessar a conexão. |
| 401 | NO_ACCESS_TOKEN | Nenhum token de autorização fornecido. É necessário fornecer um token válido 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
- O cliente envia uma requisição DELETE para
/connection/{id}para desconectar uma conexão específica. - 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 da conexão}".
- O servidor processa a requisição e desconecta a conexão correspondente ao ID fornecido.
- Em caso de sucesso, o servidor retorna o código de status 200 OK.
- Caso ocorra um erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.