API - Tarefas - Verificando o estado de uma tarefa assíncrona

Disponível a partir da versão 6.70.0

Visualizar o estado de uma tarefa assíncrona (task).

Para poder utilizar a API do Evolux, é necessário primeiro Gerar um Token.

Parâmetros da Chamada de API

Enpoint

/api/v1/tasks/{id}

Método

GET

  • ID da Tarefa
    O ID da tarefa pode ser obtido no retorno de uma API que cria uma tarefa.

  • token
    O token pode ser enviado tanto através do cabeçalho da requisição (header) quanto via query string na URL. Para gerar um token, basta seguir os passos em Tokens de API.

Só é possível visualizar o estado de uma tarefa se o token utilizado na requisição da API for o mesmo utilizado para criar a task (da mesma forma que um usuário só pode visualizar estado de tarefas criadas por ele mesmo).

Exemplos de Chamada

Exemplo de requisição - CURL

curl -X GET \ --url https://cliente.evolux.net.br/api/v1/tasks/31235ca58e474679a961ab3447d6e4ae \ -H 'token: <API_TOKEN>'

Exemplo de resposta:

{ "meta": { "status": 200, "message": "OK" }, "data": { "status": "SUCCESS", "result": "3 Subscriber(s) created, 0 updated, 0 deleted and 0 failed.", "task_id": "31235ca58e474679a961ab3447d6e4ae" } }