O método Queue/Get permite consultar a fila de processamento
1) Autenticação:
Para realizar suas chamadas à API da beeviral, é necessário antes identificar e autenticar a sua empresa. Para isso, informe o API Token no Header das suas chamadas. Assim: x-token-beeviral=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Importante: O token sempre deve ser enviado via Header
Substitua XXXXXXXXXXXXXXXXXXXXXX pelo API Token da sua empresa. Essa informação está disponível em "Configurações / Integrações", conforme a imagem abaixo:
2) Parâmetros:
Parâmetros da URL:
- id: Chave da Fila de Processamento , este id é retornado em todos os métodos POST, PUT e DELETE
Exemplo de como passar o parâmetro:
https://account.beeviral.app/api/v2/Queue/1234567890
3) Body:
O método deve ser utilizado com o Body vazio
4) Retorno:
Ao submeter os dados à API e retornar o status de HTTP 200, significa que encontrou o registro na fila de processamento.
O retorno do método será a informação de como esta o registro na fila de processamento.
[
{
"Result": [
{
"ID": "string",
"VERSION": "string",
"ORIGIN": "string",
"METHOD": "string",
"STATUS": "string",
"DESCRIPTION": "string"
}
]
}
]
| ID | Código da da fila de processamento |
| VERSION | Versão da API |
| ORIGIN | Origem do método |
| METHOD | Método chamado |
| STATUS | Status na fila de processamento:: CONCLUIDO - registro processado com sucesso FALHA - registro processado com falha PROCESSANDO - registro na fila, aguardando o processamento |
| DESCRIPTION | Descrição do processamento |
5) Testes:
Para realizar uma chamada teste ao método acesse:
URL: https://account.beeviral.app/api/swagger/ui/index
Versão: V2
Método: Queue/Get