# Oratrix API - Kanban

## Status

Documentacao parcial baseada na parte enviada para o projeto Wezapp Shots.

Este grupo trata cadastros de kanban do Oratrix. Para o Wezapp Shots, e um recurso auxiliar para organizacao de contatos, oportunidades ou relacionamento, mas nao deve controlar campanhas, saldo de shots ou fila interna de disparos.

## Base URL

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}
```

## Autenticacao

```http
Authorization: Bearer {token}
```

## Endpoints do grupo

Total documentado nesta parte: 4 endpoints.

---

## 1. Listar kanbans

```http
GET /listKanban
```

Nome na documentacao Oratrix:

```text
ListKanban
```

Descricao:

Listar kanbans disponiveis no Oratrix.

---

## 2. Criar kanban

```http
POST /createKanban
```

Nome na documentacao Oratrix:

```text
CreateKanban
```

Descricao:

Criar um novo kanban.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/createKanban
```

Body JSON:

```json
{
  "name": "Kanban 1",
  "color": "#FF5733"
}
```

---

## 3. Atualizar kanban

```http
POST /updateKanban/:id
```

Nome na documentacao Oratrix:

```text
UpdateKanban
```

Descricao:

Atualizar um kanban existente.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/updateKanban/:id
```

Body JSON:

```json
{
  "name": "Kanban Atualizado",
  "color": "#33A1FF"
}
```

---

## 4. Excluir kanban

```http
POST /deleteKanban/:id
```

Nome na documentacao Oratrix:

```text
DeleteKanban
```

Descricao:

Excluir um kanban pelo ID.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/deleteKanban/:id
```

Body JSON:

```json
{}
```

## Mapeamento sugerido com Wezapp Shots

| Wezapp Shots | Oratrix |
|---|---|
| Segmentacao futura | Kanban externo |
| Status de relacionamento futuro | Kanban externo |
| Campo externo de contato | `kanban` em endpoints de contato |

## Pendencias tecnicas para validar

- Confirmar formato de retorno de `/listKanban`.
- Confirmar se `color` aceita apenas HEX.
- Confirmar se excluir kanban afeta contatos vinculados.
- Confirmar diferenca operacional entre `kanban`, `wallet`, `pipeline` e `stage`.

## Regras recomendadas para o Wezapp Shots

1. Nao usar kanban externo para controlar saldo, campanha ou envio.
2. Usar apenas como classificacao auxiliar se necessario.
3. Registrar auditoria quando criar, atualizar ou excluir kanban via Wezapp.
4. Nao excluir kanban externo sem entender impacto nos contatos vinculados.