dev.Solubot Documentação

Endpoint: Obter Dados do QR Code

Este endpoint é usado para obter os dados do QR Code de uma conexão específica.

Requisição

        GET /connection/{id}
    

Parâmetros de entrada

Parâmetro Tipo Descrição
id string O número da conexão para obter os dados do QR Code

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

Requisição por JSON

        
            GET /connection/{id} HTTP/1.1
            Host: dev.solubot.com.br
            Content-Type: application/json
            Authorization: Bearer <token da conexão>
        
    

Requisição por Imagem de QrCode

        
            GET /connection/{id}?access_token=<token da conexão> HTTP/1.1
            Host: dev.solubot.com.br
        
    

Resposta de Sucesso

Em caso de sucesso, a requisição retornará o código de status 200 OK e os dados do QR Code no corpo da resposta.

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

  1. O cliente envia uma requisição GET para /connection/{id} para obter os dados do QR Code de 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 da conexão}".
  3. O servidor processa a requisição e retorna os dados do QR Code correspondentes ao ID fornecido.
  4. Em caso de sucesso, o servidor retorna o código de status 200 OK e os dados do QR Code no corpo da resposta.
  5. Caso ocorra um erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.