{ "info": { "name": "API do Dashboard Mágico (v1.0.0)", "description": "Você que é dev, divirta-se! ✨\n\n> **Índice da documentação** — acesse o índice completo em [https://docs.dashboards.kobana.com.br/llms.txt](https://docs.dashboards.kobana.com.br/llms.txt). Use este arquivo para descobrir todas as páginas disponíveis antes de explorar.\n\n> **Atenção às versões da API** — você está na documentação da **v1.0** da API do Dashboard Mágico, que cobre a organização, os usuários do portal e a equipe do dashboard. Recursos como **Pagamentos, Transferências, Extrato e Recebimento por Pix** seguem disponíveis em outras APIs da Kobana — use o seletor de produto no menu superior para acessá-las.\n\n## Formato\n\nA API aceita apenas o formato `JSON`. Todas as requisições devem usar `Content-Type: application/json`. Todas as respostas usam `snake_case`.\n\n| Tipo de Campo | Formato |\n| :--- | :--- |\n| **DateTime** | Formato [ISO8601](https://pt.wikipedia.org/wiki/ISO_8601). Exemplos — Data: `2026-01-24`. Data e Hora: `2026-01-24T10:07Z` |\n| **UUID** | Identificadores de recursos no formato UUID v4 |\n\n## Convenções\n\nConvenções usadas nesta documentação:\n\n| Convenção | Descrição |\n| :--- | :--- |\n| **`:variable`** | Nome de variável que precisa ser substituída em uma URL. |\n| **`#{variable}`** | Nome de variável que precisa ser substituída por valores da sua conta. |\n| **`...`** | Conteúdo da resposta truncado para facilitar a leitura. |\n| **`$KOBANA_TOKEN`** | Token de acesso. Para testes em linha de comando, exporte-o: `export KOBANA_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxx` e cole os comandos da documentação no terminal. |\n\n## Códigos de Retorno\n\nA API retorna códigos HTTP padrão:\n\n| | Código | Descrição |\n| :--- | :--- | :--- |\n| ✅ | **200 OK** | Requisição bem-sucedida com corpo de resposta. |\n| ✅ | **201 Created** | Recurso criado com sucesso. |\n| ✅ | **204 No Content** | Requisição bem-sucedida, sem corpo de resposta. |\n| ❌ | **400 Bad Request** | Requisição inválida, em geral conteúdo mal formado. |\n| ❌ | **401 Unauthorized** | Token de acesso ausente ou inválido. |\n| ❌ | **403 Forbidden** | Acesso à API bloqueado ou usuário sem permissão. |\n| ❌ | **404 Not Found** | Endereço acessado não existe. |\n| ❌ | **422 Unprocessable Entity** | Requisição válida, mas os dados enviados não são. |\n| ❌ | **429 Too Many Requests** | Limite de requisições atingido. |\n| ❌ | **500 Internal Server Error** | Erro interno no processamento. Consulte o [status dos servidores](https://status.kobana.com.br). |\n\n## ID das Requisições (Request ID)\n\nCada requisição possui um identificador associado, disponível no cabeçalho `Request-Id` da resposta. Esse valor ajuda na depuração e auditoria — as requisições e seus IDs podem ser consultadas no painel do sistema. O log de requisições fica disponível por **30 dias**. Ao abrir um chamado de suporte sobre uma requisição específica, informe o `Request-Id` para acelerar a investigação.\n\n## Segurança\n\nA API da Kobana usa certificados **SSL 2048 bits**. Toda requisição deve ser feita via **HTTPS** — chamadas na porta 80 são redirecionadas para 443.\n\nOs clientes devem suportar `TLSv1.2` ou `TLSv1.3` com uma das cifras: `TLS_AES_128_GCM_SHA256`, `TLS_AES_256_GCM_SHA384`, `TLS_CHACHA20_POLY1305_SHA256`, `ECDHE-RSA-AES128-GCM-SHA256`, `ECDHE-RSA-AES128-SHA256`, `ECDHE-RSA-AES256-GCM-SHA384`, `ECDHE-RSA-CHACHA20-POLY1305`, `ECDHE-RSA-AES256-SHA384`. `TLSv1` e `TLSv1.1` não são suportados.\n\n## Cache HTTP\n\nUse os cabeçalhos HTTP de cache para reduzir carga e ganhar velocidade. A maioria das respostas inclui `ETag` e/ou `Last-Modified` — armazene esses valores e reenvie nas próximas requisições via `If-None-Match` e `If-Modified-Since`. Se o recurso não mudou, a resposta será `304 Not Modified`, sem corpo e sem reprocessamento. Mais informações: [HTTP Cache Docs](http://www.mnot.net/cache_docs/).\n\n## Tratamento de Erros\n\nErros 5xx indicam falhas no servidor: **500 Internal Server Error** (aplicação indisponível), **502 Bad Gateway**, **503 Service Unavailable** e **504 Gateway Timeout** (falhas pontuais de infraestrutura). Sua aplicação deve identificar esses códigos e reagendar a requisição após alguns minutos com backoff. Status dos servidores: [https://status.kobana.com.br](https://status.kobana.com.br).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.dashboards.kobana.com.br", "type": "string", "description": "https://api.dashboards.kobana.com.br — Produção. Substituído em tempo de execução quando `API_V1_PUBLIC_URL` é definido.\nhttps://api.dashboards.sandbox.kobana.com.br — Sandbox — ambiente de testes isolado da produção." }, { "key": "bearerToken", "value": "", "type": "string", "description": "Access token da Conta Kobana (JWT RS256) usado no header Authorization: Bearer." } ], "item": [ { "name": "Organização", "item": [ { "name": "Obter organização atual", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/organization", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organization" ] }, "description": "Retorna os dados da organização à qual o token autenticado pertence. Não há parâmetro `:id` — a organização é sempre resolvida a partir da chave da API." }, "response": [] }, { "name": "Atualizar organização atual", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/organization", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organization" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"addresses\": [\n {}\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza o perfil cadastral da organização autenticada. Apenas os campos abaixo podem ser modificados — identidade (`id`, `external_id`, `status`) não é alterável por este endpoint." }, "response": [] }, { "name": "Identidade do token atual", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] }, "description": "Retorna quem está por trás do token Bearer: a pessoa (`user`, `null` para um token de máquina), a organização e os escopos, o nível de acesso e a expiração do próprio token. Serve para validar a credencial configurada numa integração. Nunca devolve o token, hashes ou chaves." }, "response": [] } ] }, { "name": "Usuários do Portal", "item": [ { "name": "Listar usuários do portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users?page=1&per_page=20&sort_by=&sort_order=asc&tenant_id=&status=active&email=&external_id=&sso_only=true&created_after=&created_before=&last_login_after=&last_login_before=&person_id=00000000-0000-0000-0000-000000000000&person_document_number=&person_name_contains=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "tenant_id", "value": "", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "email", "value": "", "disabled": true }, { "key": "external_id", "value": "", "disabled": true }, { "key": "sso_only", "value": "true", "disabled": true }, { "key": "created_after", "value": "", "disabled": true }, { "key": "created_before", "value": "", "disabled": true }, { "key": "last_login_after", "value": "", "disabled": true }, { "key": "last_login_before", "value": "", "disabled": true }, { "key": "person_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "person_document_number", "value": "", "disabled": true }, { "key": "person_name_contains", "value": "", "disabled": true } ] }, "description": "Retorna os usuários do portal do workspace, com paginação. Campos sensíveis (senha, tokens) nunca são expostos." }, "response": [] }, { "name": "Criar (convidar) usuário do portal", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"tenant_id\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria o usuário no workspace com status `pending_invitation` e envia o e-mail de convite. O convite expira em 7 dias." }, "response": [] }, { "name": "Convidar usuário do portal (verbo)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", "invite" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"tenant_id\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Equivalente ao `POST /portal_users`. Disponível como rota de verbo para SDKs que preferem URLs descritivas." }, "response": [] }, { "name": "Obter usuário do portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "O parâmetro `{id}` aceita o UUID ou o `external_id` do usuário." }, "response": [] }, { "name": "Atualizar usuário do portal", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"tenant_id\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"status\": \"active\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza `email`, `tenant_id`, `external_id`, `sso_only`, `status` e `custom_metadata`. Transições de status permitidas: `active` ↔ `suspended`." }, "response": [] }, { "name": "Remover usuário do portal", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Convites pendentes são removidos definitivamente; os demais usuários são suspensos." }, "response": [] }, { "name": "Pré-visualizar e-mail do usuário do portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id/email-preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id", "email-preview" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Retorna o assunto e a mensagem do e-mail de convite ou verificação que seria enviado ao usuário, sem disparar o envio. Disponível apenas para usuários `pending_invitation` ou `pending_verification`." }, "response": [] }, { "name": "Reenviar e-mail de convite ou verificação", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id", "resend" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Reenvia o e-mail de convite (para `pending_invitation`, com rotação de token) ou de verificação (para `pending_verification`). Demais status retornam 400." }, "response": [] }, { "name": "Consultar mapeamento de usuários do portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_user_mappings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_user_mappings" ] }, "description": "A entidade que alimenta os usuários do portal do workspace (`mapping`, `null` se nenhuma, com o resultado da última sincronização) e as entidades que podem ser mapeadas, com seus campos." }, "response": [] }, { "name": "Mapear entidade aos usuários do portal", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_user_mappings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_user_mappings" ] }, "body": { "mode": "raw", "raw": "{\n \"entity_type_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id_field_key\": \"\",\n \"email_field_key\": \"\",\n \"name_field_key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Mapeia uma entidade: um usuário do portal por e-mail dos seus registros, com o ID do titular vindo de um campo. Substitui o mapeamento anterior e sincroniza na hora (devolve `stats`); as próximas sincronizações da entidade mantêm os usuários em dia." }, "response": [] }, { "name": "Remover mapeamento de usuários do portal", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_user_mappings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_user_mappings" ] }, "description": "Para de sincronizar; os usuários já criados continuam." }, "response": [] } ] }, { "name": "Administração da Conta", "item": [ { "name": "Listar usuários do dashboard", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users?page=1&per_page=20&sort_by=&sort_order=asc&search=&status=all&role=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "status", "value": "all", "disabled": true }, { "key": "role", "value": "", "disabled": true } ] }, "description": "Retorna uma lista paginada dos usuários do dashboard (membros do time) da organização atual." }, "response": [] }, { "name": "Convidar usuário do dashboard", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"name\": \"\",\n \"external_id\": \"\",\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"permissions\": [\n \"\"\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Convida um novo membro para o time da organização. É obrigatório informar `email` e ao menos um papel em `role_ids`. O usuário recebe um convite por e-mail e entra com status `pending_invitation`." }, "response": [] }, { "name": "Cria ou atualiza um usuário do painel", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"name\": \"\",\n \"external_id\": \"\",\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"permissions\": [\n \"\"\n ],\n \"custom_metadata\": {},\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"public_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Localiza o usuário por `id`, `public_id`, `external_id` ou `email` — este último é único por organização. Encontrando, atualiza; caso contrário, cria e devolve `201`." }, "response": [] }, { "name": "Obter usuário do dashboard", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Atualizar usuário do dashboard", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"picture\": \"\",\n \"status\": \"active\",\n \"permissions\": [\n \"\"\n ],\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"external_id\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza nome, foto, status, permissões e/ou papéis do usuário. Apenas os campos enviados são alterados." }, "response": [] }, { "name": "Remover usuário do dashboard", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Remove o usuário do dashboard da organização. Ação irreversível — o usuário precisa ser convidado novamente para recuperar o acesso." }, "response": [] }, { "name": "Listar papéis do time", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles?page=1&per_page=20&sort_by=&sort_order=asc&search=&is_active=false&is_system=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_active", "value": "false", "disabled": true }, { "key": "is_system", "value": "false", "disabled": true } ] }, "description": "Retorna a lista paginada de papéis (roles) configurados para o time da organização. Inclui tanto papéis de sistema (`is_system = true`) quanto papéis customizados." }, "response": [] }, { "name": "Criar papel customizado", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"portal_manager\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false,\n \"external_id\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um papel customizado. O `slug` deve começar com letra minúscula e conter apenas letras minúsculas, números e `_`." }, "response": [] }, { "name": "Cria ou atualiza um papel de equipe", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"portal_manager\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false,\n \"external_id\": \"\",\n \"custom_metadata\": {},\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"public_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Localiza o papel por `id`, `public_id` ou `external_id`. O `slug` não tem restrição de unicidade e por isso **não** identifica um registro. Encontrando, atualiza; caso contrário, cria e devolve `201`." }, "response": [] }, { "name": "Obter papel", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Atualizar papel", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false,\n \"external_id\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os campos do papel. Apenas os campos enviados são alterados. Papéis de sistema têm restrições adicionais." }, "response": [] }, { "name": "Remover papel", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Realiza soft delete do papel. Papéis de sistema (`is_system = true`) não podem ser removidos." }, "response": [] }, { "name": "Consultar os workspaces de um membro", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id", "workspaces" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Lista todos os workspaces da organização, marcando os que o membro acessa — também é a lista do que pode ser concedido." }, "response": [] }, { "name": "Definir os workspaces de um membro", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id", "workspaces" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"workspace_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Substitui o conjunto de workspaces do membro. Ninguém altera o próprio acesso (400), só um dono altera o acesso de um dono, e só um dono concede ou revoga um workspace que ele mesmo não acessa (403). Um token de máquina pode conceder qualquer workspace, mas nunca altera o acesso de um dono. Tirar o último dono de um workspace responde 403." }, "response": [] }, { "name": "Reenviar convite de membro", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id", "resend" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Reenvia o e-mail de convite, com um novo link de acesso, a um membro cujo convite ainda está pendente. Limitado a 5 envios por hora por destinatário (429 acima disso)." }, "response": [] }, { "name": "Listar permissões", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/permissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "permissions" ] }, "description": "Catálogo das permissões do dashboard que um membro ou um papel da equipe pode ter, agrupadas por recurso — o vocabulário de `permissions` em `/dashboard_users` e `/team_roles`." }, "response": [] } ] }, { "name": "Workspaces", "item": [ { "name": "Listar workspaces", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces?page=1&per_page=20&sort_by=&sort_order=asc&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Lista os workspaces da organização que você pode abrir, com o seu papel em cada um — os mesmos do seletor do dashboard. Um token de máquina vê todos os workspaces da organização. Não exige `X-Workspace-Id`." }, "response": [] }, { "name": "Criar workspace", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um workspace vazio na organização. A pessoa do token vira dona dele. Criado por um token de máquina, o workspace fica sem dono: os donos da organização o recebem no próximo login, e `PUT /dashboard_users/{id}/workspaces` o concede a outros membros." }, "response": [] }, { "name": "Importar workspace", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", "import" ] }, "body": { "mode": "raw", "raw": "{\n \"data\": {},\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Restaura um arquivo de `GET /workspaces/{id}/export` em um workspace NOVO, cujo dono é a pessoa do token. Responde o que não pôde ser trazido de volta (`warnings`) para terminar à mão. Exige um token de pessoa (um token de máquina recebe 403) com as permissões de criar workspaces, configurar o portal e criar fontes de dados. As entidades do arquivo passam pelas mesmas validações de quando são criadas uma a uma (chaves, expressões, limite de campos do workspace). O corpo é limitado a 2 MB." }, "response": [] }, { "name": "Consultar workspace", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna um workspace que você pode abrir. Um workspace sem acesso concedido responde 404." }, "response": [] }, { "name": "Renomear workspace", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Renomeia o workspace. Só os donos do workspace podem (403 para um membro comum)." }, "response": [] }, { "name": "Excluir workspace", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Exclui o workspace (exclusão lógica), só para os donos dele: o portal sai do ar, os conectores param de sincronizar e os membros perdem o acesso. O último workspace da organização não pode ser excluído." }, "response": [] }, { "name": "Consultar o conteúdo do workspace", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id", "usage" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Conta o que a exclusão do workspace esconderia — o mesmo resumo do diálogo de exclusão do dashboard." }, "response": [] }, { "name": "Exportar workspace", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id/export", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id", "export" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Baixa a configuração do workspace (construtor do portal, acesso e configurações do portal, mapeamento de usuários, conectores e entidades) como um arquivo JSON, só para os donos dele. Segredos e dados ficam de fora. A resposta é o próprio arquivo, sem envelope `data`; envie-o como `data` em `POST /workspaces/import`." }, "response": [] } ] }, { "name": "Fontes de Dados", "item": [ { "name": "Listar fontes de dados", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources?page=1&per_page=20&sort_by=&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true } ] }, "description": "Fontes de dados do workspace — APIs OpenAPI, servidores MCP e bancos somente leitura —, das mais novas para as mais antigas. Os segredos nunca são devolvidos. Para criar uma fonte, use a rota do tipo: `/data_sources/openapi`, `/mcp`, `/database` ou `/catalog`." }, "response": [] }, { "name": "Listar produtos do catálogo Kobana", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/catalog", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "catalog" ] }, "description": "Produtos Kobana que podem ser conectados como fonte de dados só com um token. Lista completa, sem paginação." }, "response": [] }, { "name": "Conectar produto Kobana", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/catalog", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "catalog" ] }, "body": { "mode": "raw", "raw": "{\n \"product\": \"\",\n \"environment\": \"production\",\n \"token\": \"\",\n \"workspace_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Salva uma fonte OpenAPI a partir da spec do produto que acompanha a aplicação e testa a conexão." }, "response": [] }, { "name": "Criar fonte OpenAPI", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/openapi", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "openapi" ] }, "body": { "mode": "raw", "raw": "{\n \"spec\": \"\",\n \"spec_file_name\": \"\",\n \"certificate\": {\n \"filename\": \"\",\n \"content_base64\": \"\"\n },\n \"name\": \"\",\n \"base_url\": \"\",\n \"auth\": {\n \"kind\": \"none\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"credentials\": {\n \"token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificate_password\": \"\"\n },\n \"response_format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Salva uma API descrita por uma spec OpenAPI, importa suas operações e testa a conexão. A spec vai como texto em `spec`; o certificado mTLS, em base64 em `certificate`." }, "response": [] }, { "name": "Analisar spec OpenAPI", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/openapi/analyze", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "openapi", "analyze" ] }, "body": { "mode": "raw", "raw": "{\n \"spec\": \"\",\n \"spec_file_name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Lê a spec e devolve o que seria importado — título, servidores, esquemas de segurança, autenticação sugerida e operações — sem salvar nada." }, "response": [] }, { "name": "Criar fonte MCP", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/mcp", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "mcp" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"transport\": \"http\",\n \"headers\": \"\",\n \"oauth\": {\n \"mode\": \"none\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Salva um servidor MCP. Sem OAuth, conecta e descobre as tools na hora; com OAuth, devolve `authorization_url`, que uma pessoa logada no dashboard precisa abrir no navegador para concluir." }, "response": [] }, { "name": "Criar fonte de banco de dados", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/database", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "database" ] }, "body": { "mode": "raw", "raw": "{\n \"engine\": \"postgres\",\n \"name\": \"\",\n \"host\": \"\",\n \"port\": 0,\n \"database\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"connection_string\": \"\",\n \"ssl\": false,\n \"ssl_verify\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Salva um banco somente leitura (PostgreSQL, MySQL, MariaDB, SQL Server ou MongoDB), conecta e cataloga as tabelas ou coleções." }, "response": [] }, { "name": "Testar conexão antes de salvar", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "test" ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"openapi\",\n \"spec\": \"\",\n \"spec_file_name\": \"\",\n \"certificate\": {\n \"filename\": \"\",\n \"content_base64\": \"\"\n },\n \"name\": \"\",\n \"base_url\": \"\",\n \"auth\": {\n \"kind\": \"none\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"credentials\": {\n \"token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificate_password\": \"\"\n },\n \"response_format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Testa uma conexão ainda não salva. Informe `kind` (`openapi`, `mcp`, `database` ou `catalog`) e o corpo da rota de criação correspondente. Nada é persistido." }, "response": [] }, { "name": "Consultar fonte de dados", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "A fonte de dados e suas operações (endpoints, tools ou tabelas que ela pode ler)." }, "response": [] }, { "name": "Atualizar fonte de dados", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": false,\n \"base_url\": \"\",\n \"auth\": {\n \"kind\": \"none\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"credentials\": {\n \"token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificate_password\": \"\"\n },\n \"certificate\": {\n \"filename\": \"\",\n \"content_base64\": \"\"\n },\n \"probe_operation_key\": \"\",\n \"default_params\": {},\n \"response_format\": \"json\",\n \"url\": \"\",\n \"transport\": \"http\",\n \"headers\": \"\",\n \"oauth\": {\n \"mode\": \"none\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\"\n },\n \"engine\": \"postgres\",\n \"host\": \"\",\n \"port\": 0,\n \"database\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"connection_string\": \"\",\n \"ssl\": false,\n \"ssl_verify\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza nome, `is_active` e os campos de conexão do tipo da fonte. Campos secretos em branco mantêm os guardados. Uma fonte OpenAPI recebe um novo certificado em `certificate`." }, "response": [] }, { "name": "Excluir fonte de dados", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Remove a fonte, suas operações e a agenda de sincronização. As entidades alimentadas por ela deixam de sincronizar. Não pode ser desfeito." }, "response": [] }, { "name": "Testar fonte de dados", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "test" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Testa a fonte salva e registra o resultado (status, último erro). Num servidor MCP, também atualiza a lista de tools." }, "response": [] }, { "name": "Sincronizar fonte de dados", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "sync" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"full\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Enfileira a sincronização de todas as entidades alimentadas pela fonte. A execução é assíncrona." }, "response": [] }, { "name": "Agendar sincronização da fonte", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/schedule", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "schedule" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"cron\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Define com que frequência a fonte sincroniza: `{ cron, timezone }`, ou `{ cron: null }` para só sob demanda. Devolve as próximas execuções." }, "response": [] }, { "name": "Substituir spec da fonte", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/spec", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "spec" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"spec\": \"\",\n \"spec_file_name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Troca a spec OpenAPI e ressincroniza as operações: as que mantêm a chave mantêm suas configurações; as que sumiram da spec são removidas." }, "response": [] }, { "name": "Autorizar fonte MCP", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/authorize", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "authorize" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Reinicia a autorização OAuth de um servidor MCP. Devolve `authorization_url` para uma pessoa logada no dashboard abrir no navegador, ou `null` e o teste de conexão quando os tokens guardados ainda funcionam." }, "response": [] }, { "name": "Listar log de requisições da fonte", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/logs?page=1&per_page=20&sort_by=&sort_order=asc&method=&success=true&search=&date_from=2026-01-01&date_to=2026-01-01", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "logs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "method", "value": "", "disabled": true }, { "key": "success", "value": "true", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "disabled": true }, { "key": "date_to", "value": "2026-01-01", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Chamadas que a fonte fez (requisições HTTP, consultas ao banco), das mais novas para as mais antigas, sem cabeçalhos nem corpos." }, "response": [] }, { "name": "Consultar requisição da fonte", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/logs/:log_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "logs", ":log_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "log_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Uma chamada inteira: cabeçalhos e corpos da requisição e da resposta, com segredos mascarados." }, "response": [] }, { "name": "Ligar ou desligar operação da fonte", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/operations/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "operations", ":operation_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "operation_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Liga ou desliga uma operação da fonte (`enabled`). Operações desligadas não alimentam entidades." }, "response": [] } ] }, { "name": "Entidades", "item": [ { "name": "Listar entidades", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities" ] }, "description": "Todas as entidades do workspace, com campos, origem e estado da sincronização, ordenadas pelo nome. Sem paginação." }, "response": [] }, { "name": "Criar entidade", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities" ] }, "body": { "mode": "raw", "raw": "{\n \"integration_id\": \"00000000-0000-0000-0000-000000000000\",\n \"operation_id\": \"00000000-0000-0000-0000-000000000000\",\n \"sql\": \"\",\n \"params\": {},\n \"pagination\": {\n \"style\": \"none\",\n \"page_param\": \"\",\n \"offset_param\": \"\",\n \"cursor_param\": \"\",\n \"size_param\": \"\",\n \"limit_param\": \"\",\n \"next_cursor_path\": \"\",\n \"page_size\": 0\n },\n \"sync_filters\": [\n {\n \"target\": \"\",\n \"op\": \"eq\",\n \"value\": {}\n }\n ],\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"identifier_field_key\": \"\",\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\",\n \"owner_match\": \"external_id\",\n \"sync_mode\": \"scheduled\",\n \"freshness_seconds\": 0,\n \"fields\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"data_type\": \"string\",\n \"semantic_role\": \"identifier\",\n \"source_path\": \"\",\n \"expression\": \"\",\n \"format\": \"\",\n \"enum_options\": [\n {}\n ],\n \"visible\": false,\n \"filterable\": false,\n \"sortable\": false\n }\n ],\n \"records_path\": \"\",\n \"sample\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Registra uma entidade a partir de uma operação de leitura (ou consulta SQL) da fonte de dados com os campos escolhidos, e enfileira a primeira sincronização completa." }, "response": [] }, { "name": "Prévia de uma origem", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", "preview" ] }, "body": { "mode": "raw", "raw": "{\n \"integration_id\": \"00000000-0000-0000-0000-000000000000\",\n \"operation_id\": \"00000000-0000-0000-0000-000000000000\",\n \"sql\": \"\",\n \"params\": {},\n \"pagination\": {\n \"style\": \"none\",\n \"page_param\": \"\",\n \"offset_param\": \"\",\n \"cursor_param\": \"\",\n \"size_param\": \"\",\n \"limit_param\": \"\",\n \"next_cursor_path\": \"\",\n \"page_size\": 0\n },\n \"sync_filters\": [\n {\n \"target\": \"\",\n \"op\": \"eq\",\n \"value\": {}\n }\n ],\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Chama a operação de leitura escolhida (ou roda a consulta SQL) e devolve a amostra com a entidade inferida dela. Nada é gravado; a chamada fica no log de requisições do conector." }, "response": [] }, { "name": "Criar entidade de relação", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/join", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", "join" ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"join\": {\n \"base_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"related_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"base_field\": \"\",\n \"related_field\": \"\",\n \"type\": \"inner\",\n \"match\": \"exact\"\n },\n \"fields\": [\n {\n \"from\": \"base\",\n \"field_key\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registra uma entidade que relaciona duas outras (join) com os campos escolhidos de cada uma, e enfileira a primeira sincronização." }, "response": [] }, { "name": "Prévia de uma relação", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/join/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", "join", "preview" ] }, "body": { "mode": "raw", "raw": "{\n \"base_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"related_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"base_field\": \"\",\n \"related_field\": \"\",\n \"type\": \"inner\",\n \"match\": \"exact\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Como duas entidades casam nos campos informados (contagens) e as primeiras linhas combinadas, antes de salvar a relação. Lê só os registros já sincronizados." }, "response": [] }, { "name": "Consultar entidade", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Uma entidade com campos, origem, modo de sincronização, campo do titular e estado da sincronização." }, "response": [] }, { "name": "Atualizar entidade", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"identifier_field_key\": \"\",\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\",\n \"owner_match\": \"external_id\",\n \"sync_mode\": \"scheduled\",\n \"freshness_seconds\": 0,\n \"fields\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"data_type\": \"string\",\n \"semantic_role\": \"identifier\",\n \"source_path\": \"\",\n \"expression\": \"\",\n \"format\": \"\",\n \"enum_options\": [\n {}\n ],\n \"visible\": false,\n \"filterable\": false,\n \"sortable\": false\n }\n ],\n \"pagination\": {\n \"style\": \"none\",\n \"page_param\": \"\",\n \"offset_param\": \"\",\n \"cursor_param\": \"\",\n \"size_param\": \"\",\n \"limit_param\": \"\",\n \"next_cursor_path\": \"\",\n \"page_size\": 0\n },\n \"sync_filters\": [\n {\n \"target\": \"\",\n \"op\": \"eq\",\n \"value\": {}\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Nome, chave, campos especiais, paginação, filtros e modo da sincronização, e a lista de campos (casada por chave). Quando o mapeamento muda, os registros são relidos." }, "response": [] }, { "name": "Remover entidade", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Remove (soft delete) a entidade e seus campos. Recusado (409) enquanto uma entidade de relação a lê." }, "response": [] }, { "name": "Alterar relação", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/join", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "join" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"join\": {\n \"base_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"related_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"base_field\": \"\",\n \"related_field\": \"\",\n \"type\": \"inner\",\n \"match\": \"exact\"\n },\n \"fields\": [\n {\n \"from\": \"base\",\n \"field_key\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Troca a relação de uma entidade join e os campos que ela traz, e relê seus registros. 422 quando a entidade não é uma relação." }, "response": [] }, { "name": "Consultar registros", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/records?limit=50&offset=0&sort=due_date:desc,name&filter={\"status\":\"open\",\"amount\":{\"gte\":100}}&preview_as=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "records" ], "query": [ { "key": "limit", "value": "50", "disabled": true }, { "key": "offset", "value": "0", "disabled": true }, { "key": "sort", "value": "due_date:desc,name", "disabled": true }, { "key": "filter", "value": "{\"status\":\"open\",\"amount\":{\"gte\":100}}", "disabled": true }, { "key": "preview_as", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Os registros sincronizados da entidade, com filtro por campo, ordenação e paginação por `limit`/`offset` (a mesma consulta dos blocos do portal)." }, "response": [] }, { "name": "Limpar registros", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/records", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "records" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Remove todos os registros sincronizados da entidade e zera o estado da sincronização, para a próxima ler a origem do zero." }, "response": [] }, { "name": "Consultar registro", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/records/:record_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "records", ":record_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "record_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Um registro sincronizado — valores por campo e o registro como a origem o enviou — com a sua entidade." }, "response": [] }, { "name": "Agregar registros", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/aggregate?op=count&field=&group_by=&filter={\"status\":\"open\",\"amount\":{\"gte\":100}}&preview_as=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "aggregate" ], "query": [ { "key": "op", "value": "count", "disabled": true }, { "key": "field", "value": "", "disabled": true }, { "key": "group_by", "value": "", "disabled": true }, { "key": "filter", "value": "{\"status\":\"open\",\"amount\":{\"gte\":100}}", "disabled": true }, { "key": "preview_as", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Contagem, soma, média, mínimo ou máximo sobre os registros sincronizados, opcionalmente agrupados por um campo — o que os blocos de KPI e gráfico mostram." }, "response": [] }, { "name": "Uso da entidade", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "usage" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "As páginas do portal (rascunho e publicada) cujos blocos leem a entidade — o que quebra se ela for removida ou sua chave mudar." }, "response": [] }, { "name": "Log da sincronização", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/logs?page=1&per_page=20&method=&success=true&search=&date_from=2026-01-01&date_to=2026-01-31", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "logs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "method", "value": "", "disabled": true }, { "key": "success", "value": "true", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "As chamadas que a sincronização da entidade fez ao conector, das mais novas às mais antigas: o log de requisições do conector restrito à entidade." }, "response": [] }, { "name": "Consultar chamada da sincronização", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/logs/:log_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "logs", ":log_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "log_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Uma chamada da sincronização da entidade, inteira (segredos mascarados)." }, "response": [] }, { "name": "Sincronizar entidade", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/sync?full=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "sync" ], "query": [ { "key": "full", "value": "true", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Enfileira uma sincronização da entidade e responde 202 com o ID; o andamento fica em `GET /entities/{id}/sync`. Uma entidade `on_access` não tem sincronização geral (422): use `POST /entities/{id}/tenant_syncs`." }, "response": [] }, { "name": "Estado da sincronização", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "sync" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Onde está a sincronização da entidade: status, último erro, últimas sincronizações, total de registros e estatísticas." }, "response": [] }, { "name": "Sincronizações por titular", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/tenant_syncs?page=1&per_page=20&status=queued&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "tenant_syncs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "status", "value": "queued", "disabled": true }, { "key": "search", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Em uma entidade `on_access`: onde está a sincronização de cada titular, dos acessados mais recentemente aos mais antigos." }, "response": [] }, { "name": "Sincronizar um titular", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/tenant_syncs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "tenant_syncs" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"tenant_id\": \"\",\n \"full\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Enfileira agora a sincronização de um titular de uma entidade `on_access`. 404 quando nenhum usuário do portal tem esse Tenant ID; 422 quando a entidade não é `on_access`." }, "response": [] } ] }, { "name": "Construtor do Portal", "item": [ { "name": "Consultar o construtor do portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder" ] }, "description": "Retorna o portal do workspace como o construtor o vê: identidade do portal, rascunho (páginas na ordem do menu, cada uma com sua marca em relação à versão no ar, `revision` e `dirty`), número da versão no ar, versões publicadas, tema e SEO padrão. Leia a `revision` daqui antes de salvar o rascunho." }, "response": [] }, { "name": "Salvar o rascunho do portal", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/draft", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "draft" ] }, "body": { "mode": "raw", "raw": "{\n \"revision\": 0,\n \"pages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"title\": \"\",\n \"seo\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"canonical\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n },\n \"show_in_menu\": false,\n \"content\": {}\n }\n ],\n \"editor_state\": {},\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"radius\": \"0.5rem\"\n },\n \"seo_defaults\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Substitui o rascunho inteiro — páginas na ordem do menu, estado do editor e, opcionalmente, tema e SEO padrão — protegido pela `revision` lida por último. Uma `revision` desatualizada responde 409 e não altera nada. Nada vai ao ar: para publicar, use `POST /portal_builder/publish`." }, "response": [] }, { "name": "Publicar o portal", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "publish" ] }, "body": { "mode": "raw", "raw": "{\n \"revision\": 0,\n \"pages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"title\": \"\",\n \"seo\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"canonical\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n },\n \"show_in_menu\": false,\n \"content\": {}\n }\n ],\n \"editor_state\": {},\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"radius\": \"0.5rem\"\n },\n \"seo_defaults\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n },\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Salva o rascunho como enviado (mesmo corpo do salvamento, mais uma `note` opcional) e o congela como a próxima versão, numa única transação: os visitantes do portal passam a vê-la na hora. Um campo de formulário cuja expressão regular pode travar a validação responde 422 `UNSAFE_FIELD_PATTERN`." }, "response": [] }, { "name": "Consultar uma versão publicada", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/versions/:number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "versions", ":number" ], "variable": [ { "key": "number", "value": "3" } ] }, "description": "Retorna uma versão publicada do portal, pelo número, com as páginas que ela congelou." }, "response": [] }, { "name": "Restaurar uma versão", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/versions/:number/rollback", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "versions", ":number", "rollback" ], "variable": [ { "key": "number", "value": "3" } ] }, "description": "Coloca essa versão de volta no ar como o próximo número — os visitantes do portal a veem na hora. Retorna a nova versão e o construtor como ficou." }, "response": [] }, { "name": "Criptografar um segredo de bloco", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/secrets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "secrets" ] }, "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"url\": \"https://hooks.example.com/in\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Criptografa um valor que um bloco guarda no JSON da página (um cabeçalho de webhook como `Authorization`). Retorna `secret:`, vinculado a este workspace e à origem de `url` (obrigatória), que só o servidor abre para enviar a requisição a essa origem. Nada é armazenado: salve o valor retornado no bloco junto com o rascunho." }, "response": [] }, { "name": "Enviar uma imagem og:image", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/og_image", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "og_image" ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"cover.png\",\n \"content_type\": \"image/png\",\n \"content_base64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Envia a og:image de uma página (ou do SEO padrão) — a imagem que as prévias de link mostram — e retorna a URL pública, para guardar em `seo.og_image_url` (ou `seo_defaults.og_image_url`) no próximo salvamento do rascunho. PNG, JPEG ou WebP, em base64; até 2 MB de imagem, mas o corpo inteiro da requisição tem limite de 2 MB (cerca de 1,5 MB de imagem depois de codificada)." }, "response": [] }, { "name": "Testar um formulário do rascunho", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/form_submissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "form_submissions" ] }, "body": { "mode": "raw", "raw": "{\n \"form_id\": \"\",\n \"form_title\": \"\",\n \"page_path\": \"\",\n \"fields\": [\n {\n \"label\": \"\",\n \"name\": \"\",\n \"type\": \"text\",\n \"required\": false,\n \"pattern\": \"\"\n }\n ],\n \"action\": {\n \"type\": \"email\",\n \"email_to\": \"\",\n \"email_subject\": \"\",\n \"email_template\": \"\",\n \"webhook_endpoint_id\": \"\"\n },\n \"values\": {},\n \"submitter\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Executa a ação de um bloco Formulário como a prévia do construtor: o e-mail configurado sai de verdade (ou o webhook escolhido dispara de verdade), marcado como `preview: true`. A configuração do formulário vem no corpo. O e-mail de teste vai só para o e-mail do operador do token (um token sem operador não testa a ação de e-mail). Limitado a 20 execuções por minuto por operador, 60 por minuto e 500 por dia por organização, compartilhando o limite com a prévia do painel." }, "response": [] }, { "name": "Testar um botão de ação do rascunho", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/action_runs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "action_runs" ] }, "body": { "mode": "raw", "raw": "{\n \"block_id\": \"\",\n \"label\": \"\",\n \"page_path\": \"\",\n \"request\": {\n \"method\": \"POST\",\n \"url\": \"\",\n \"headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"body\": \"\"\n },\n \"submitter\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Executa o webhook de um Botão de ação como a prévia do construtor: a requisição sai de verdade, marcada como `preview: true`, e a resposta traz o status HTTP devolvido pelo destino. Cabeçalhos podem levar valores `secret:` criados por `POST /portal_builder/secrets`, que só abrem para a origem para a qual foram criados. Limitado a 20 execuções por minuto por operador, 60 por minuto e 500 por dia por organização." }, "response": [] } ] }, { "name": "Configurações do Portal", "item": [ { "name": "Obter configurações do portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings" ] }, "description": "Retorna a configuração do portal do workspace: marca, idioma da página, cores, endereço, opções de login e SSO, notificações e remetente, e configurações do site (cabeçalhos de segurança, SEO, rastreadores, chat e código próprio)." }, "response": [] }, { "name": "Atualizar configurações do portal", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings" ] }, "body": { "mode": "raw", "raw": "{\n \"company_name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"html_lang\": \"pt-BR\",\n \"light_colors\": {\n \"primary\": \"222 47% 11%\"\n },\n \"signup_slug\": \"\",\n \"enable_login\": false,\n \"enable_email_login\": false,\n \"allow_password_change\": false,\n \"sso_enabled\": false,\n \"sso_public_key\": \"\",\n \"sso_algorithm\": \"RS256\",\n \"sso_issuer\": \"\",\n \"notification_type_statuses\": {\n \"account_suspended\": \"ACTIVE\",\n \"account_activated\": \"ACTIVE\",\n \"portal_invitation\": \"ACTIVE\",\n \"welcome\": \"ACTIVE\"\n },\n \"notification_bcc_emails\": [\n {\n \"label\": \"\",\n \"address\": \"user@example.com\"\n }\n ],\n \"notification_sender_name\": \"\",\n \"notification_sender_email\": \"\",\n \"notification_reply_to_email\": \"\",\n \"hsts_include_subdomains\": false,\n \"hsts_preload\": false,\n \"secure_frame_headers\": false,\n \"seo_indexing_enabled\": false,\n \"seo_robots_txt\": \"\",\n \"seo_sitemap_enabled\": false,\n \"seo_google_site_verification\": \"\",\n \"seo_canonical_url\": \"\",\n \"tracking_integrations\": {},\n \"chat_integrations\": {},\n \"custom_code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza a configuração do portal do workspace. Parcial: só os campos enviados mudam. Retorna a configuração completa." }, "response": [] }, { "name": "Enviar imagem do portal", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "logo" ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"logo.png\",\n \"content_type\": \"image/png\",\n \"content_base64\": \"\",\n \"variant\": \"logo\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Envia o logo, o logo para fundos escuros ou o favicon do portal, em base64 no corpo JSON. Substitui a imagem anterior." }, "response": [] }, { "name": "Remover imagem do portal", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/logo?variant=logo", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "logo" ], "query": [ { "key": "variant", "value": "logo", "disabled": true } ] }, "description": "Remove o logo, o logo para fundos escuros ou o favicon; o portal volta ao padrão." }, "response": [] }, { "name": "Definir endereço do portal", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/domain", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "domain" ] }, "body": { "mode": "raw", "raw": "{\n \"slug\": \"acme\",\n \"domain\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Define o endereço do portal na plataforma, `https://{slug}.{domain}`, ou o remove quando os dois são `null`." }, "response": [] }, { "name": "Verificar disponibilidade do endereço", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/domain/check_slug?slug=acme&domain=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "domain", "check_slug" ], "query": [ { "key": "slug", "value": "acme", "disabled": false }, { "key": "domain", "value": "", "disabled": false } ] }, "description": "Informa se `slug.domain` está livre para o portal deste workspace (o endereço atual dele conta como livre)." }, "response": [] }, { "name": "Verificar remetente das notificações", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/sender_identity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "sender_identity" ] }, "description": "Pede ou confere a verificação do remetente no AWS SES. Se o endereço nunca foi enviado ao SES ou a verificação falhou, o SES envia a ele um link de confirmação; senão, consulta a situação atual." }, "response": [] } ] }, { "name": "Domínios Próprios do Portal", "item": [ { "name": "Listar domínios próprios", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains" ] }, "description": "Lista os domínios próprios do portal do workspace (conjunto completo, sem paginação). Vazia onde domínios próprios não são suportados." }, "response": [] }, { "name": "Adicionar domínio próprio", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains" ] }, "body": { "mode": "raw", "raw": "{\n \"hostname\": \"portal.example.com\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registra um domínio próprio como `pending_verification`, sem acionar a AWS, e retorna os registros DNS a publicar. Depois chame `POST /portal_custom_domains/{id}/verify`. O registro é só uma reivindicação: o domínio fica com o primeiro portal que publicar o TXT de verificação (as outras reivindicações não comprovadas são liberadas), e uma reivindicação não comprovada expira em 7 dias. Cada portal tem no máximo 10 domínios. Domínios da plataforma (`kobana.com.br`, `kobana.tech` e os domínios compartilhados de portal) não são aceitos. 403 onde domínios próprios não estão disponíveis." }, "response": [] }, { "name": "Remover domínio próprio", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Remove o domínio próprio e desfaz o tenant da CloudFront e o certificado, quando provisionados. O portal deixa de responder nesse endereço." }, "response": [] }, { "name": "Verificar e provisionar domínio próprio", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains/:id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains", ":id", "verify" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Enquanto pendente, confere o DNS e provisiona o domínio na AWS (certificado e tenant da CloudFront); depois de provisionado, atualiza a situação. Retorna o domínio com o novo `status`." }, "response": [] }, { "name": "Consultar DNS do domínio próprio", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains/:id/dns_status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains", ":id", "dns_status" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Consulta somente leitura dos CNAMEs exigidos, registro a registro, sem alterar nada na AWS." }, "response": [] } ] }, { "name": "Provedores OIDC do Portal", "item": [ { "name": "Listar provedores OIDC", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers" ] }, "description": "Lista os provedores OpenID Connect com que os usuários entram no portal (conjunto completo, sem paginação)." }, "response": [] }, { "name": "Adicionar provedor OIDC", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"button_label\": \"\",\n \"issuer_url\": \"https://example.com\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"email_claim\": \"\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Adiciona um provedor OpenID Connect ao login do portal." }, "response": [] }, { "name": "Atualizar provedor OIDC", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"button_label\": \"\",\n \"issuer_url\": \"https://example.com\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"email_claim\": \"\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza um provedor OpenID Connect. Parcial: só os campos enviados mudam." }, "response": [] }, { "name": "Remover provedor OIDC", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Remove o provedor; o botão some do login e ninguém mais entra por ele." }, "response": [] }, { "name": "Testar emissor OIDC", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers", "test" ] }, "body": { "mode": "raw", "raw": "{\n \"issuer_url\": \"https://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Busca o documento de descoberta do emissor e informa seus endpoints, para validar a URL antes de salvar. Uma falha na descoberta é um 200 com `ok: false`." }, "response": [] } ] }, { "name": "Webhooks", "item": [ { "name": "Listar endpoints de webhook", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks?page=1&per_page=20&sort_by=&sort_order=asc&status=active&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Lista os endpoints de webhook do workspace, do mais recente ao mais antigo, com o total de entregas de cada um." }, "response": [] }, { "name": "Criar endpoint de webhook", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks\",\n \"events\": [\n \"api_key.db.created\"\n ],\n \"description\": \"\",\n \"auth_type\": \"none\",\n \"auth_config\": {\n \"token\": \"token-123\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um endpoint ativo no workspace. A resposta traz o `secret` de assinatura — ele só aparece aqui (e na rotação)." }, "response": [] }, { "name": "Consultar endpoint de webhook", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna um endpoint de webhook do workspace. As entregas ficam em `GET /webhooks/{id}/deliveries`." }, "response": [] }, { "name": "Atualizar endpoint de webhook", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"active\": false,\n \"auth_type\": \"none\",\n \"auth_config\": {\n \"token\": \"token-123\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Altera URL, descrição, eventos assinados, `active` ou a autenticação. Campos ausentes ficam como estão." }, "response": [] }, { "name": "Excluir endpoint de webhook", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Exclui o endpoint definitivamente, junto com o log de entregas. Os eventos deixam de ser enviados na hora." }, "response": [] }, { "name": "Enviar webhook de teste", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Envia agora um evento `test.webhook` assinado para a URL do endpoint e o registra no log de entregas. Responde 200 com `success: false` quando o endpoint responde fora de 2xx ou não é alcançado, e 422 quando a URL aponta para um endereço bloqueado (rede privada)." }, "response": [] }, { "name": "Rotacionar segredo do webhook", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/rotate_secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "rotate_secret" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Gera um novo segredo de assinatura. O anterior deixa de valer na hora; o novo `secret` só aparece nesta resposta." }, "response": [] }, { "name": "Listar entregas de um webhook", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/deliveries?page=1&per_page=20&sort_by=&sort_order=asc&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "deliveries" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Log de entregas de um endpoint, da mais recente à mais antiga." }, "response": [] }, { "name": "Reenviar entrega de webhook", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/deliveries/:delivery_id/retry", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "deliveries", ":delivery_id", "retry" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "delivery_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Coloca a entrega de volta em `pending` e a enfileira para novo envio. O envio é assíncrono: acompanhe o resultado no log de entregas." }, "response": [] }, { "name": "Listar entregas de webhook", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_deliveries?page=1&per_page=20&sort_by=&sort_order=asc&status=pending&webhook_id=00000000-0000-0000-0000-000000000000&date_from=&date_to=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_deliveries" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "pending", "disabled": true }, { "key": "webhook_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Entregas de todos os endpoints do workspace, da mais recente à mais antiga, com o tipo do evento e o resumo do endpoint." }, "response": [] }, { "name": "Consultar entrega de webhook", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_deliveries/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_deliveries", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna uma entrega: requisição (redigida), resposta, tentativas e o endpoint de destino." }, "response": [] } ] }, { "name": "Eventos", "item": [ { "name": "Listar eventos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/events?page=1&per_page=20&sort_by=&sort_order=asc&type=&resource_type=&resource_id=00000000-0000-0000-0000-000000000000&date_from=&date_to=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "resource_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Log de eventos do workspace e da organização, do mais recente ao mais antigo. Eventos são evidência: não podem ser alterados nem excluídos." }, "response": [] }, { "name": "Consultar evento", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/events/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna um evento com o payload completo." }, "response": [] } ] }, { "name": "Auditoria", "item": [ { "name": "Listar registros de auditoria", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/audit_logs?page=1&per_page=20&sort_by=&sort_order=asc&user_id=&action=&resource_type=&resource_id=&search=&date_from=&date_to=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_logs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "user_id", "value": "", "disabled": true }, { "key": "action", "value": "", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "resource_id", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Trilha de auditoria do workspace e da organização, do mais recente ao mais antigo. A trilha não pode ser alterada." }, "response": [] }, { "name": "Resumo da atividade auditada", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/audit_logs/summary?hours=24", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_logs", "summary" ], "query": [ { "key": "hours", "value": "24", "disabled": true } ] }, "description": "Atividade das últimas `hours` horas: total de registros, as 10 ações mais frequentes e os 20 registros mais recentes. Exige a permissão de exportar auditoria." }, "response": [] }, { "name": "Consultar registro de auditoria", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/audit_logs/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna um registro de auditoria com valores anteriores e novos." }, "response": [] } ] }, { "name": "Modelos de E-mail", "item": [ { "name": "Listar modelos de e-mail", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates?type=api_key_expiring&is_active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates" ], "query": [ { "key": "type", "value": "api_key_expiring", "disabled": true }, { "key": "is_active", "value": "true", "disabled": true } ] }, "description": "Lista os modelos de e-mail da própria organização, ordenados por tipo e nome. Retorna o conjunto inteiro, sem paginação." }, "response": [] }, { "name": "Criar modelo de e-mail", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"api_key_expiring\",\n \"subject\": \"\",\n \"html_body\": \"\",\n \"text_body\": \"\",\n \"bcc\": [\n \"\"\n ],\n \"variables\": [\n \"\"\n ],\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um modelo para um tipo de notificação. Fica como rascunho, a menos que `is_active` seja `true` — nesse caso o modelo ativo anterior do tipo vira rascunho." }, "response": [] }, { "name": "Restaurar modelos padrão", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/init_defaults", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", "init_defaults" ] }, "description": "Cria ou restaura o modelo de cada tipo de notificação com o conteúdo padrão e o ativa. Sobrescreve o conteúdo dos modelos existentes da organização." }, "response": [] }, { "name": "Consultar modelo de e-mail", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna um modelo da organização ou um modelo padrão da plataforma." }, "response": [] }, { "name": "Atualizar modelo de e-mail", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"subject\": \"\",\n \"html_body\": \"\",\n \"text_body\": \"\",\n \"bcc\": [\n \"\"\n ],\n \"variables\": [\n \"\"\n ],\n \"is_active\": false,\n \"public_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza um modelo da organização. Só os campos enviados mudam. Modelos padrão da plataforma não podem ser alterados (404)." }, "response": [] }, { "name": "Excluir modelo de e-mail", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Exclui definitivamente um modelo inativo da organização. O modelo ativo de um tipo não pode ser excluído (422): ative outro antes." }, "response": [] }, { "name": "Duplicar modelo de e-mail", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Copia um modelo como rascunho (inativo)." }, "response": [] }, { "name": "Pré-visualizar modelo de e-mail", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id", "preview" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Renderiza o modelo com dados de exemplo, dentro do layout da organização. Nada é enviado." }, "response": [] }, { "name": "Renderizar modelo com variáveis", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id", "preview" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"variables\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Renderiza o modelo com as `variables` enviadas, sem layout. Nada é enviado." }, "response": [] } ] }, { "name": "Layouts de E-mail", "item": [ { "name": "Listar layouts de e-mail", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts" ] }, "description": "Lista os layouts de e-mail da organização, o padrão primeiro. Retorna o conjunto inteiro, sem paginação." }, "response": [] }, { "name": "Criar layout de e-mail", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"html_body\": \"\",\n \"is_default\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um layout. O HTML precisa conter o marcador `{{content}}`." }, "response": [] }, { "name": "Criar layout padrão", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/init_defaults", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", "init_defaults" ] }, "description": "Garante que a organização tenha um layout padrão: retorna o atual ou cria o embutido. Nunca sobrescreve um layout." }, "response": [] }, { "name": "Consultar layout de e-mail", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna um layout da organização." }, "response": [] }, { "name": "Atualizar layout de e-mail", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"html_body\": \"\",\n \"is_default\": false,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza nome, HTML (que deve manter `{{content}}`), padrão ou ativo. Só os campos enviados mudam." }, "response": [] }, { "name": "Excluir layout de e-mail", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Exclui definitivamente um layout. Os e-mails passam a usar o layout padrão (ou o embutido)." }, "response": [] } ] }, { "name": "Notificações", "item": [ { "name": "Listar notificações", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications?page=1&per_page=20&sort_by=&sort_order=asc&type=api_key_expiring&channel=email&status=pending&created_after=&created_before=&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "type", "value": "api_key_expiring", "disabled": true }, { "key": "channel", "value": "email", "disabled": true }, { "key": "status", "value": "pending", "disabled": true }, { "key": "created_after", "value": "", "disabled": true }, { "key": "created_before", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Lista as notificações do workspace e as da organização inteira, das mais novas para as mais antigas." }, "response": [] }, { "name": "Criar notificação", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"api_key_expiring\",\n \"recipient\": \"\",\n \"channel\": \"email\",\n \"portal_user_id\": \"00000000-0000-0000-0000-000000000000\",\n \"resource_type\": \"\",\n \"resource_id\": \"00000000-0000-0000-0000-000000000000\",\n \"scheduled_for\": \"2026-01-01T00:00:00Z\",\n \"variables\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Renderiza o modelo ativo do tipo com as variáveis, grava a notificação e a envia na hora — a resposta traz o resultado (`sent`, ou `failed` com `failure_reason`). Com um `scheduled_for` no futuro, ela fica `pending` até a hora marcada. Cada criação conta no limite de envios manuais por destinatário (429)." }, "response": [] }, { "name": "Estatísticas de notificações", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications/stats?days=30", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "stats" ], "query": [ { "key": "days", "value": "30", "disabled": true } ] }, "description": "Contagens por status, tipo e canal das notificações criadas nos últimos `days` dias, com as taxas de entrega e de leitura." }, "response": [] }, { "name": "Enviar notificação", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", ":id", "send" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Envia agora uma notificação gravada: o primeiro envio de uma `pending` (agendada) ou `skipped`, ou o reenvio de uma `sent`, `delivered`, `read` ou `failed`. Cada chamada envia o e-mail de novo e conta no limite de envios manuais por destinatário (429)." }, "response": [] } ] }, { "name": "Chaves de API", "item": [ { "name": "Listar chaves de API", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys?page=1&per_page=20&sort_by=&sort_order=asc&status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true } ] }, "description": "Lista as chaves de API (`kb_…`) da organização, sem o segredo. Essas chaves não autenticam mais a API v1 nem o MCP — ambos usam tokens de acesso emitidos pelo servidor de autorização da Kobana; os registros continuam como inventário de chaves da organização (ciclo de vida, avisos de expiração e webhooks `api_key.*`). Recurso da organização: não usa `X-Workspace-Id`." }, "response": [] }, { "name": "Criar chave de API", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"source\": \"api\",\n \"notification_emails\": [\n \"\"\n ],\n \"expires_at\": \"2026-01-01T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria uma chave ativa, válida por um ano salvo `expires_at`. O segredo (`key`) volta UMA única vez nesta resposta — só o hash é guardado. Exige uma pessoa que alcance todos os workspaces (dona da organização ou com acesso a cada um), como no painel." }, "response": [] }, { "name": "Consultar chave de API", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Retorna uma chave da organização — metadados e carimbos do ciclo de vida, nunca o segredo." }, "response": [] }, { "name": "Atualizar chave de API", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"source\": \"api\",\n \"notification_emails\": [\n \"\"\n ],\n \"expires_at\": \"2026-01-01T00:00:00Z\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Edita nome, descrição, origem, e-mails de aviso e validade, e/ou ativa ⇄ desativa a chave com `enabled`. Chave revogada é definitiva (409)." }, "response": [] }, { "name": "Remover chave revogada", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Tira da lista uma chave JÁ REVOGADA (exclusão lógica; o histórico fica). Uma chave ativa ou desativada precisa ser revogada antes (409)." }, "response": [] }, { "name": "Revogar chave de API", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id", "revoke" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Revoga a chave em definitivo — não pode ser reativada. 409 se já estiver revogada." }, "response": [] }, { "name": "Rotacionar chave de API", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id/rotate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id", "rotate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"grace_days\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Emite uma chave sucessora (mesmo nome e configurações) e mantém a anterior funcionando por `grace_days` dias (padrão 7, máximo 30). Só uma chave ativa pode ser rotacionada (409). O segredo novo volta UMA única vez." }, "response": [] } ] }, { "name": "Exportações", "item": [ { "name": "Listar exportações", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports?page=1&per_page=20&sort_by=&sort_order=asc&resource_type=&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Lista os pedidos de exportação do workspace." }, "response": [] }, { "name": "Solicitar exportação", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports" ] }, "body": { "mode": "raw", "raw": "{\n \"resource_type\": \"portal_users\",\n \"format\": \"csv\",\n \"filters\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Agenda a exportação dos usuários do portal do workspace em CSV, XLSX ou JSON. Assíncrono: responde 202 com a exportação `pending`; consulte `GET /exports/{id}` até `completed` e baixe em `/download`. O arquivo expira em 7 dias." }, "response": [] }, { "name": "Consultar exportação", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Status e metadados de um pedido de exportação." }, "response": [] }, { "name": "Baixar arquivo da exportação", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports", ":id", "download" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devolve o arquivo de uma exportação concluída (o painel redireciona para uma URL assinada; a API entrega os bytes). 404 enquanto não estiver pronta." }, "response": [] } ] }, { "name": "Importações", "item": [ { "name": "Listar importações", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/imports?page=1&per_page=20&sort_by=&sort_order=asc&resource_type=&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "imports" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Lista os pedidos de importação do workspace, com contadores de sucesso e erro." }, "response": [] }, { "name": "Importar CSV", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/imports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "imports" ] }, "body": { "mode": "raw", "raw": "{\n \"resource_type\": \"portal_users\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"content_base64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Envia um CSV em base64 e agenda a importação de usuários do portal no workspace. O painel faz upload prévio do arquivo; a API o recebe no corpo (limite de 2 MB por requisição). Segue a configuração da organização \"permitir criar usuários do portal\" (403 quando desligada). Assíncrono: 202; consulte `GET /imports/{id}`." }, "response": [] }, { "name": "Consultar importação", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/imports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "imports", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Status, contadores e erros por linha de uma importação. Uma importação ainda `pending` 2 minutos depois do pedido aparece como `failed` (fila parada), sem que a consulta altere o registro." }, "response": [] } ] }, { "name": "Backups", "item": [ { "name": "Listar backups", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups?page=1&per_page=20&sort_by=&sort_order=asc&type=backup&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "type", "value": "backup", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Lista backups e restaurações da organização (só metadados) e informa se um novo backup pode ser pedido agora (`backup_allowed`, `next_backup_at` — um a cada 12 horas em produção). Recurso da organização." }, "response": [] }, { "name": "Solicitar backup", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups" ] }, "description": "Agenda um backup completo (ZIP) da organização, com todos os workspaces. Assíncrono: 202; consulte `GET /backups/{id}`." }, "response": [] }, { "name": "Restaurar backup", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/restore", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", "restore" ] }, "body": { "mode": "raw", "raw": "{\n \"backup_id\": \"00000000-0000-0000-0000-000000000000\",\n \"file_name\": \"\",\n \"content_base64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "DESTRUTIVO: restaura um backup no workspace da chamada (`X-Workspace-Id`), regravando usuários do portal casados por e-mail/ID público. Informe `backup_id` (um backup concluído desta organização — o arquivo é copiado) OU `file_name` (`.zip`) + `content_base64` (limitado aos 2 MB da requisição). Exige `settings.update` e acesso a todos os workspaces. Assíncrono: 202; acompanhe em `GET /backups/{id}` e cancele com `/cancel`." }, "response": [] }, { "name": "Consultar backup", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Status e progresso de um backup ou restauração. Uma restauração em andamento cujo job sumiu da fila é marcada como `failed`." }, "response": [] }, { "name": "Excluir backup", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Exclui o registro e o arquivo do armazenamento. Definitivo." }, "response": [] }, { "name": "Cancelar restauração", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id", "cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Interrompe uma restauração pendente ou em andamento. O que já foi restaurado permanece. 422 para um backup ou uma restauração já encerrada." }, "response": [] }, { "name": "Baixar backup", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id", "download" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devolve o ZIP do backup. Exige `backups.export` e, para token de uma pessoa, ser dona da organização ou ter acesso a todos os workspaces — o backup contém todos eles. Fica registrado na auditoria." }, "response": [] } ] }, { "name": "Limpeza de Dados", "item": [ { "name": "Contar dados apagáveis", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_purges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_purges" ] }, "description": "Quantos registros cada recurso apagável (`portal_users`, `people`, `usage_history`) tem somando todos os workspaces. Exige `data.purge` (por padrão só donos da organização) e acesso a todos os workspaces." }, "response": [] }, { "name": "Apagar dados da organização", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_purges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_purges" ] }, "body": { "mode": "raw", "raw": "{\n \"resources\": [\n \"portal_users\"\n ],\n \"confirm\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "IRREVERSÍVEL: apaga em definitivo os recursos escolhidos em TODOS os workspaces da organização. No painel, a operação é confirmada com um código enviado por e-mail. Por isso, um token que identifica uma pessoa (token pessoal, OAuth ou chamada pelo MCP) recebe 403: a pessoa faz a limpeza pelo painel. Só tokens de máquina podem limpar pela API, e só quando o token traz o escopo dedicado `dashboards/data_purges:write` — concedido explicitamente: nenhum outro escopo o implica (nem `write`, `all`, `dashboards/all` ou `dashboards/admin:write`); sem ele, 403 `insufficient_scope`. A confirmação deles é `confirm`, que precisa repetir o ID da organização (de `GET /organization`) — uma chamada repetida ou endereçada à organização errada não passa por engano. Exige `data.purge` (por padrão só donos da organização) e acesso a todos os workspaces. Assíncrono: 202 com `job_id`." }, "response": [] }, { "name": "Acompanhar limpeza", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_purges/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_purges", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Progresso e resultado de um job de limpeza. Job de outra organização: 404." }, "response": [] } ] }, { "name": "Manutenção", "item": [ { "name": "Colocar nomes em maiúsculas", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/maintenance/uppercase_names", "host": [ "{{baseUrl}}" ], "path": [ "v1", "maintenance", "uppercase_names" ] }, "description": "Converte para maiúsculas o nome de todo contato vinculado a um usuário do portal do workspace. Não é reversível (a grafia anterior não é guardada)." }, "response": [] } ] }, { "name": "Configurações", "item": [ { "name": "Consultar configurações da organização", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "settings" ] }, "description": "Nome, e-mail de suporte, fuso horário e as opções de cadastros da organização. Recurso da organização." }, "response": [] }, { "name": "Atualizar configurações da organização", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "settings" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"user@example.com\",\n \"timezone\": \"\",\n \"crm_uppercase_names\": false,\n \"crm_allow_edit_public_id\": false,\n \"crm_allow_edit_document\": false,\n \"crm_allow_create_customers\": false,\n \"crm_allow_create_portal_users\": false,\n \"crm_allow_edit_portal_user_email\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Altera parcialmente as configurações: envie só o que muda. Campos desconhecidos são recusados (400)." }, "response": [] } ] }, { "name": "Consumo", "item": [ { "name": "Consultar consumo da plataforma", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage?start_date=2026-01-15&end_date=2026-01-15", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ], "query": [ { "key": "start_date", "value": "2026-01-15", "disabled": true }, { "key": "end_date", "value": "2026-01-15", "disabled": true } ] }, "description": "Para cada métrica (membros, clientes, usuários do portal, integrações…), a série diária no período, o valor mais recente e o pico. Padrão: mês corrente; no máximo 12 meses para trás. Recurso da organização." }, "response": [] } ] }, { "name": "Uso de IA", "item": [ { "name": "Consultar uso de IA", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/ai_usage?start_date=2026-01-15&end_date=2026-01-15&days=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ai_usage" ], "query": [ { "key": "start_date", "value": "2026-01-15", "disabled": true }, { "key": "end_date", "value": "2026-01-15", "disabled": true }, { "key": "days", "value": "0", "disabled": true } ] }, "description": "Consumo de IA, só preço (custo e margem nunca saem): totais, detalhamento diário e últimos turnos do workspace da chamada, mais o acumulado do mês, franquias, limites, saldo de crédito e se o próximo turno é permitido — esses da organização inteira, pois o limite e o crédito são compartilhados. Período padrão: mês corrente (America/Sao_Paulo), no máximo 366 dias." }, "response": [] } ] }, { "name": "Limites de Requisição", "item": [ { "name": "Consultar limites de requisição", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/rate_limits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "rate_limits" ] }, "description": "Os limites de requisição em vigor para a organização, se são personalizados (definidos pela equipe Kobana) e os padrões da plataforma. Somente leitura." }, "response": [] } ] }, { "name": "Arquivos", "item": [ { "name": "Listar arquivos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets?page=1&per_page=20&sort_by=&sort_order=asc&kind=image&visibility=public&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "kind", "value": "image", "disabled": true }, { "key": "visibility", "value": "public", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "A biblioteca de arquivos do workspace — imagens e documentos que o portal mostra ou oferece para download. Ordenável por `created_at` (padrão), `name` ou `size_bytes`." }, "response": [] }, { "name": "Adicionar arquivo", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"key\": \"\",\n \"content_base64\": \"\",\n \"content_type\": \"\",\n \"alt_text\": \"\",\n \"visibility\": \"public\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registra um arquivo na biblioteca, de um de dois jeitos: o `key` de um arquivo já enviado pela URL de `POST /assets/presign`, ou o próprio conteúdo em `content_base64`. O arquivo começa `restricted`, a menos que `visibility` diga outra coisa. Dispara o webhook `asset.created`." }, "response": [] }, { "name": "Gerar URL de envio", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/presign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", "presign" ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"content_type\": \"\",\n \"size\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Uma URL assinada e de curta duração para enviar o arquivo direto ao storage com `PUT` — o caminho para arquivos acima do limite de 2 MB do corpo. Depois do `PUT`, registre o arquivo em `POST /assets` com o `key` devolvido." }, "response": [] }, { "name": "Consultar arquivo", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Um arquivo da biblioteca, com o link, a visibilidade, o tipo e o tamanho." }, "response": [] }, { "name": "Atualizar arquivo", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"alt_text\": \"\",\n \"visibility\": \"public\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Renomeia o arquivo, troca o texto alternativo ou a visibilidade. Tornar público abre a URL do storage para qualquer pessoa; `restricted` ou `private` a fecha." }, "response": [] }, { "name": "Remover arquivo", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Tira o arquivo da biblioteca. O arquivo guardado continua no storage, para que links já publicados não quebrem. Dispara o webhook `asset.deleted`." }, "response": [] }, { "name": "Baixar arquivo", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id/download?inline=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id", "download" ], "query": [ { "key": "inline", "value": "true", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "O conteúdo do arquivo, qualquer que seja a visibilidade, com o `Content-Type` dele." }, "response": [] } ] } ] }