Chat Pró Oratrix: API Externa — To Do List

Chatbot Pró da Oratrix
, , ,
1

Chat Pró Oratrix: API Externa — To Do List

:parrot: SERVIÇO

Serviço: Chat Pró Oratrix

:hammer_and_wrench: VOCÊ VAI PRECISAR

  • URL base: https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}.
  • Token de autenticação {token}.
  • Um cliente HTTP, como Postman ou código próprio.

:receipt: VISÃO GERAL

A família To Do List permite criar, listar, atualizar e excluir tarefas, além de consultar logs por usuário pela API externa do Chat Pró Oratrix.

As rotas utilizam a base https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID} e autenticação pelo header Authorization: Bearer {token}.

:compass: PASSO A PASSO GUIADO

  1. Substitua {ApiID} pelo identificador correto da API externa.
  2. Envie o header Authorization: Bearer {token}.
  3. Use Content-Type: application/json nas requisições com corpo JSON.
  4. Escolha a operação desejada:
Método Endpoint Finalidade
POST /todo/create Criar tarefa
GET /todo/list Listar tarefas
POST /todo/update/{id} Atualizar status
POST /todo/delete/{id} Excluir tarefa
GET /todo/logs/{userId} Consultar logs do usuário

Criar tarefa

POST https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/todo/create

Campos documentados: name, description, owner, ownerId, status e priority.

Atualizar tarefa

POST https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/todo/update/{id}

O corpo documentado utiliza o campo status.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: Preserve exatamente os nomes dos endpoints e campos.
  • :warning: Não compartilhe o {token} em tickets, prints ou logs públicos.
  • :warning: 400 indica parâmetros inválidos ou ausentes.
  • :warning: 401 indica token ausente, inválido ou sem permissão.

:gear: DICAS E BOAS PRÁTICAS

  • Teste primeiro em uma tarefa de homologação.
  • Guarde os IDs retornados para atualização e exclusão.
  • Registre somente dados necessários nos logs da integração.

:bar_chart: RESULTADO ESPERADO

A integração poderá criar e manter tarefas da To Do List e consultar seus registros pela API.

:receipt: RESUMO FINAL

Use as rotas /todo/* a partir de https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID} com Authorization: Bearer {token}.

:label: KEYWORDS

API, To Do List, tarefas, integração, Chat Pró Oratrix