Automation: Acessorias
Endpoint da WebApiAlcance para automação de obrigações acessórias - dispara a rotina de login automático no portal Acessórias (e-Continuo) através de um scraper executado de forma assíncrona via Celery. A chamada não bloqueia: ela cria um registro de Worker, enfileira a task na fila scraping e retorna imediatamente com a confirmação de agendamento.
Todos os endpoints exigem autenticação. Veja Autenticação para o fluxo de API Key. O Swagger oficial está em api.contabilidadealcance.com.br/docs.
Base path
/api/v1/automation/acessoriasEscopos necessários
Escopo derivado de automation
O recurso do escopo é derivado do 1º segmento após /api/v1/, que aqui é automation - não automation_acessorias. Portanto os escopos válidos são automation:read e automation:write. Esse mesmo par de escopos é compartilhado com Automation: Tax: uma API Key com automation:write habilita a escrita em ambos os domínios de automação.
automation:write- enfileirar automações (ex.: oPOST /automation/acessorias/login)automation:read- consultas de leitura sob o recursoautomation(quando existirem)
A ação é definida pelo método HTTP: read para GET, write para POST/PUT/DELETE.
Endpoints
POST /automation/acessorias/login
Enfileira o login automático no Acessórias (e-Continuo) para o usuário informado. A chamada busca o usuário por user_id, cria um registro Worker (status: "AGENDADO", automation_type: "login_acessorias", queue: "scraping"), dispara a task Celery login_acessorias via apply_async gravando o task_id retornado, registra a atividade e o log da automação, e responde imediatamente com o envelope de sucesso. Como a execução é assíncrona, acompanhe o andamento pelo Worker/task_id gerado - consulte Worker Automation para os endpoints de status de task (ex.: GET /worker-automation/status/{task_id}).
Parâmetros
| Parâmetro | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
user_id | int | query | sim | ID do usuário cujo login será automatizado. |
Request
Sem corpo de requisição - o user_id é enviado como parâmetro de query.
Response 200 OK
{
"success": true,
"message": "Automação agendada com sucesso.",
"data": null
}Quando o usuário não é encontrado, a resposta foge do envelope padrão e retorna { "error": "Usuário não encontrado" }.
Escopo: automation:write
Notas
- Toda resposta de sucesso segue o envelope
{ success, message, data }. O caso de usuário inexistente foge do envelope padrão e retorna{ "error": "Usuário não encontrado" }. - A task roda na fila
scrapingdo Celery. Para estados da task (PENDING,STARTED,SUCCESS,FAILURE,RETRY,REVOKED) e monitoramento, veja Worker Automation e /conceitos/tasks-celery. - O login em si é feito por um scraper (e-Continuo). Falhas de credencial ou de acesso ao portal são registradas nos logs de automação, e o
Workercorrespondente reflete o resultado final da execução. - Os escopos
automation:read/automation:writesão compartilhados com Automation: Tax - ambos derivam do recursoautomation.