{ "contractVersion": "1.0.0", "state": "available_production", "operations": [ { "method": "GET", "path": "/me", "operationId": "getMe", "summary": "Identidade mínima e contexto autorizado", "permission": "identity:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "principal", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 224 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/me", "operationId": "updateMe", "summary": "Atualizar nome/foto do perfil com o contrato permitido pelo produto", "permission": "profile:update", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 225 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/me/preferences", "operationId": "getMePreferences", "summary": "Consultar/alterar preferências do próprio usuário, incluindo app selecionado", "permission": "preferences:read", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 226 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/me/preferences", "operationId": "updateMePreferences", "summary": "Consultar/alterar preferências do próprio usuário, incluindo app selecionado", "permission": "preferences:update", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 226 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/capabilities", "operationId": "getCapabilities", "summary": "Operações habilitadas e limites visíveis ao principal", "permission": "capabilities:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "principal", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 227 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/apps", "operationId": "getApps", "summary": "Apps visíveis à credencial, com paginação", "permission": "apps:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "allowed_apps", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 228 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/apps", "operationId": "createApps", "summary": "Criar aplicativo com configurações iniciais", "permission": "apps:create", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 229 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/apps/{appId}", "operationId": "getAppsAppId", "summary": "Consultar cadastro e configuração", "permission": "apps:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 230 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/apps/{appId}", "operationId": "updateAppsAppId", "summary": "Atualizar nome, destinos e campos permitidos", "permission": "apps:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 231 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/apps/{appId}", "operationId": "deleteAppsAppId", "summary": "Excluir respeitando links, domínios, templates e histórico", "permission": "apps:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 232 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/apps/{appId}/capabilities", "operationId": "getAppsAppIdCapabilities", "summary": "Habilitações e restrições efetivas", "permission": "capabilities:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 233 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/apps/{appId}/defaults", "operationId": "getAppsAppIdDefaults", "summary": "Padrões de domínio, destinos e apresentação", "permission": "apps:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 234 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/apps/{appId}/defaults", "operationId": "setAppsAppIdDefaults", "summary": "Padrões de domínio, destinos e apresentação", "permission": "apps:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 234 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/apps/{appId}/logo", "operationId": "getAppsAppIdLogo", "summary": "Consultar, associar e remover logo via ativo autorizado", "permission": "apps:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 235 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/apps/{appId}/logo", "operationId": "setAppsAppIdLogo", "summary": "Consultar, associar e remover logo via ativo autorizado", "permission": "apps:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 235 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/apps/{appId}/logo", "operationId": "deleteAppsAppIdLogo", "summary": "Consultar, associar e remover logo via ativo autorizado", "permission": "apps:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 235 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/apps/{appId}/usage", "operationId": "getAppsAppIdUsage", "summary": "Uso, quotas técnicas e limites por categoria", "permission": "usage:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 236 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/api-keys", "operationId": "getApiKeys", "summary": "Metadados das credenciais, sem segredo", "permission": "api_keys:read", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 237 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/api-keys", "operationId": "createApiKeys", "summary": "Emitir credencial limitada", "permission": "api_keys:create", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 238 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/api-keys/{keyId}", "operationId": "getApiKeysKeyId", "summary": "Consultar/alterar metadados e restrições permitidas", "permission": "api_keys:read", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 239 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/api-keys/{keyId}", "operationId": "updateApiKeysKeyId", "summary": "Consultar/alterar metadados e restrições permitidas", "permission": "api_keys:update", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 239 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/api-keys/{keyId}/rotate", "operationId": "rotateApiKeysKeyId", "summary": "Rotação com política explícita de sobreposição", "permission": "api_keys:rotate", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 240 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/api-keys/{keyId}", "operationId": "deleteApiKeysKeyId", "summary": "Revogação", "permission": "api_keys:delete", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 241 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/audit-events", "operationId": "getAuditEvents", "summary": "Atividade de conta filtrada ao proprietário", "permission": "audit_events:read", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 242 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/requests", "operationId": "getRequests", "summary": "Diagnóstico sanitizado das requisições da conta", "permission": "requests:read", "credentials": [ "human" ], "oauthAvailability": "excluded", "resourceScope": "subject_owned", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 243 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/links", "operationId": "getLinks", "summary": "Listar/buscar por app, domínio, grupo, estado, tags, pasta, campanha e período", "permission": "links:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 251 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/links", "operationId": "createLinks", "summary": "Criar link web/deep link com idempotência", "permission": "links:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 252 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/links/{linkId}", "operationId": "getLinksLinkId", "summary": "Consultar contrato administrativo e revisão", "permission": "links:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 253 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/links/{linkId}", "operationId": "updateLinksLinkId", "summary": "Atualizar campos mutáveis com revisão", "permission": "links:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 254 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/links/{linkId}", "operationId": "deleteLinksLinkId", "summary": "Exclusão autorizada com revisão e dependências", "permission": "links:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 255 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/links/{linkId}/duplicate", "operationId": "duplicateLinksLinkId", "summary": "Criar novo link a partir de configuração existente", "permission": "links:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 256 }, "idempotency": "required", "ifMatch": "none" }, { "method": "POST", "path": "/links/validate", "operationId": "validateLinks", "summary": "Validar entrada e indicar conflitos conhecidos sem reservar endereço", "permission": "links:validate", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 257 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/links/availability", "operationId": "getLinksAvailability", "summary": "Consultar disponibilidade de domínio/prefixo/slug autorizado", "permission": "links:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 258 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/links/{linkId}/preview", "operationId": "previewLinksLinkId", "summary": "Simular destino por cenário sem gerar clique nem fazer redirect", "permission": "links:preview", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 259 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/links/{linkId}/publication", "operationId": "getLinksLinkIdPublication", "summary": "Consultar revisão desejada/confirmada e estado de sincronização", "permission": "links:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 260 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/links/{linkId}/resync", "operationId": "resyncLinksLinkId", "summary": "Solicitar ressincronização via outbox", "permission": "links:resync", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 261 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/links/{linkId}/history", "operationId": "getLinksLinkIdHistory", "summary": "Histórico administrativo sanitizado de alterações", "permission": "link_history:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 262 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/links/{linkId}/template-selection", "operationId": "getLinksLinkIdTemplateSelection", "summary": "Ler/alterar apresentação por plataforma", "permission": "template_bindings:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 263 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/links/{linkId}/template-selection", "operationId": "setLinksLinkIdTemplateSelection", "summary": "Ler/alterar apresentação por plataforma", "permission": "template_bindings:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 263 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/links/{linkId}/tags", "operationId": "getLinksLinkIdTags", "summary": "Ler/substituir associação de tags do mesmo app", "permission": "tags:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 264 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/links/{linkId}/tags", "operationId": "setLinksLinkIdTags", "summary": "Ler/substituir associação de tags do mesmo app", "permission": "tags:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 264 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/links/{linkId}/routing-rules", "operationId": "getLinksLinkIdRoutingRules", "summary": "Ler/alterar regras avançadas previstas no pacote de expansão", "permission": "routing_rules:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 265 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/links/{linkId}/routing-rules", "operationId": "setLinksLinkIdRoutingRules", "summary": "Ler/alterar regras avançadas previstas no pacote de expansão", "permission": "routing_rules:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 265 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/tags", "operationId": "getTags", "summary": "Listar/criar etiquetas por app", "permission": "tags:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 277 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/tags", "operationId": "createTags", "summary": "Listar/criar etiquetas por app", "permission": "tags:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 277 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/tags/{tagId}", "operationId": "getTagsTagId", "summary": "Consultar/renomear/remover etiqueta", "permission": "tags:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 278 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/tags/{tagId}", "operationId": "updateTagsTagId", "summary": "Consultar/renomear/remover etiqueta", "permission": "tags:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 278 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/tags/{tagId}", "operationId": "deleteTagsTagId", "summary": "Consultar/renomear/remover etiqueta", "permission": "tags:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 278 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/folders", "operationId": "getFolders", "summary": "Listar/criar pastas", "permission": "folders:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 279 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/folders", "operationId": "createFolders", "summary": "Listar/criar pastas", "permission": "folders:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 279 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/folders/{folderId}", "operationId": "getFoldersFolderId", "summary": "Gerir pasta e restrições de remoção", "permission": "folders:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 280 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/folders/{folderId}", "operationId": "updateFoldersFolderId", "summary": "Gerir pasta e restrições de remoção", "permission": "folders:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 280 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/folders/{folderId}", "operationId": "deleteFoldersFolderId", "summary": "Gerir pasta e restrições de remoção", "permission": "folders:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 280 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/campaigns", "operationId": "getCampaigns", "summary": "Listar/criar campanhas", "permission": "campaigns:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 281 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/campaigns", "operationId": "createCampaigns", "summary": "Listar/criar campanhas", "permission": "campaigns:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 281 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/campaigns/{campaignId}", "operationId": "getCampaignsCampaignId", "summary": "Gerir metadados, UTMs padrão e arquivamento", "permission": "campaigns:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 282 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/campaigns/{campaignId}", "operationId": "updateCampaignsCampaignId", "summary": "Gerir metadados, UTMs padrão e arquivamento", "permission": "campaigns:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 282 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/campaigns/{campaignId}", "operationId": "deleteCampaignsCampaignId", "summary": "Gerir metadados, UTMs padrão e arquivamento", "permission": "campaigns:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 282 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/campaigns/{campaignId}/links", "operationId": "getCampaignsCampaignIdLinks", "summary": "Links vinculados, paginados", "permission": "campaigns:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 283 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/domains", "operationId": "getDomains", "summary": "Listar domínios autorizados e estados", "permission": "domains:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 291 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/domains", "operationId": "createDomains", "summary": "Solicitar domínio de plataforma ou conectar domínio próprio", "permission": "domains:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 292 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/domains/{domainId}", "operationId": "getDomainsDomainId", "summary": "Detalhe, instruções e pendências", "permission": "domains:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 293 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/domains/{domainId}/capabilities", "operationId": "getDomainsDomainIdCapabilities", "summary": "Ações possíveis para aquele modo e usuário", "permission": "capabilities:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 294 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/domains/{domainId}/verify", "operationId": "verifyDomainsDomainId", "summary": "Verificar propriedade, DNS, TLS e prontidão", "permission": "domains:verify", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 295 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/domains/{domainId}", "operationId": "deleteDomainsDomainId", "summary": "Desvincular com dependências e operação recuperável", "permission": "domains:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 296 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/domains/{domainId}/dns-records", "operationId": "getDomainsDomainIdDnsRecords", "summary": "Listar registros administráveis", "permission": "dns:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "managed_dns", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 297 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/domains/{domainId}/dns-records", "operationId": "createDomainsDomainIdDnsRecords", "summary": "Criar registro permitido", "permission": "dns:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "managed_dns", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 298 }, "idempotency": "required", "ifMatch": "required" }, { "method": "PATCH", "path": "/domains/{domainId}/dns-records/{recordId}", "operationId": "updateDomainsDomainIdDnsRecordsRecordId", "summary": "Alterar/remover registro permitido", "permission": "dns:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "managed_dns", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 299 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/domains/{domainId}/dns-records/{recordId}", "operationId": "deleteDomainsDomainIdDnsRecordsRecordId", "summary": "Alterar/remover registro permitido", "permission": "dns:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "managed_dns", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 299 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/domains/{domainId}/native-config", "operationId": "getDomainsDomainIdNativeConfig", "summary": "Configuração Android, iOS, scheme e rotas", "permission": "native_config:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 300 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/domains/{domainId}/native-config", "operationId": "setDomainsDomainIdNativeConfig", "summary": "Configuração Android, iOS, scheme e rotas", "permission": "native_config:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 300 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/domains/{domainId}/web-config", "operationId": "getDomainsDomainIdWebConfig", "summary": "Destino web, metadados e prefixo", "permission": "web_config:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 301 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/domains/{domainId}/web-config", "operationId": "setDomainsDomainIdWebConfig", "summary": "Destino web, metadados e prefixo", "permission": "web_config:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 301 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/domains/{domainId}/recovery-config", "operationId": "getDomainsDomainIdRecoveryConfig", "summary": "Opções de recuperação disponíveis", "permission": "recovery_config:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "recovery", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 302 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/domains/{domainId}/recovery-config", "operationId": "setDomainsDomainIdRecoveryConfig", "summary": "Opções de recuperação disponíveis", "permission": "recovery_config:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "recovery", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 302 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/domains/{domainId}/template-defaults", "operationId": "getDomainsDomainIdTemplateDefaults", "summary": "Padrões de templates por plataforma", "permission": "template_bindings:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 303 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/domains/{domainId}/template-defaults", "operationId": "setDomainsDomainIdTemplateDefaults", "summary": "Padrões de templates por plataforma", "permission": "template_bindings:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 303 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/domains/{domainId}/diagnostics", "operationId": "getDomainsDomainIdDiagnostics", "summary": "Diagnóstico estruturado das associações e publicação", "permission": "domains:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 304 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/domain-options", "operationId": "getDomainOptions", "summary": "Opções de plataforma e orientações suportadas de domínio raiz", "permission": "domains:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 305 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/template-catalog", "operationId": "getTemplateCatalog", "summary": "Modelos oficiais, plataformas e capacidades", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 315 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/template-catalog/{baseId}/schema", "operationId": "getTemplateCatalogBaseIdSchema", "summary": "Campos, variáveis, tipos e restrições", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 316 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/templates", "operationId": "getTemplates", "summary": "Biblioteca e criação por app", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 317 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/templates", "operationId": "createTemplates", "summary": "Biblioteca e criação por app", "permission": "templates:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 317 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/templates/{templateId}", "operationId": "getTemplatesTemplateId", "summary": "Detalhe, nome e arquivamento", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 318 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/templates/{templateId}", "operationId": "updateTemplatesTemplateId", "summary": "Detalhe, nome e arquivamento", "permission": "templates:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 318 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/templates/{templateId}/duplicate", "operationId": "duplicateTemplatesTemplateId", "summary": "Duplicar rascunho ou versão", "permission": "templates:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 319 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/templates/{templateId}/draft", "operationId": "getTemplatesTemplateIdDraft", "summary": "Consultar/salvar rascunho com revisão própria", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 320 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/templates/{templateId}/draft", "operationId": "setTemplatesTemplateIdDraft", "summary": "Consultar/salvar rascunho com revisão própria", "permission": "templates:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 320 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/templates/{templateId}/validate", "operationId": "validateTemplatesTemplateId", "summary": "Validar configuração e variáveis", "permission": "templates:validate", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 321 }, "idempotency": "required", "ifMatch": "none" }, { "method": "POST", "path": "/templates/{templateId}/preview", "operationId": "previewTemplatesTemplateId", "summary": "Prévia com dados autorizados, sem publicação", "permission": "templates:preview", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 322 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/templates/{templateId}/versions", "operationId": "getTemplatesTemplateIdVersions", "summary": "Listar/preparar snapshots imutáveis", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 323 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/templates/{templateId}/versions", "operationId": "createTemplatesTemplateIdVersions", "summary": "Listar/preparar snapshots imutáveis", "permission": "templates:snapshot", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 323 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/templates/{templateId}/versions/{version}", "operationId": "getTemplatesTemplateIdVersionsVersion", "summary": "Consultar snapshot", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 324 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/templates/{templateId}/publish", "operationId": "publishTemplatesTemplateId", "summary": "Publicar versão com alvos explícitos", "permission": "templates:publish", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 325 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/templates/{templateId}/restore", "operationId": "restoreTemplatesTemplateId", "summary": "Restaurar versão confirmada", "permission": "templates:publish", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 326 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/templates/{templateId}/availability", "operationId": "getTemplatesTemplateIdAvailability", "summary": "Versões disponíveis para associação", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 327 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/template-publications", "operationId": "getTemplatePublications", "summary": "Listar publicações por app/template/alvo", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 328 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/template-publications/{publicationId}", "operationId": "getTemplatePublicationsPublicationId", "summary": "Estado detalhado por destino", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 329 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/template-publications/{publicationId}/retry", "operationId": "retryTemplatePublicationsPublicationId", "summary": "Repetir tentativa recuperável", "permission": "templates:retry", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 330 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/apps/{appId}/template-defaults", "operationId": "getAppsAppIdTemplateDefaults", "summary": "Padrões por app", "permission": "template_bindings:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 331 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PUT", "path": "/apps/{appId}/template-defaults", "operationId": "setAppsAppIdTemplateDefaults", "summary": "Padrões por app", "permission": "template_bindings:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "path_app", "capability": "templates", "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 331 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/template-choices", "operationId": "getTemplateChoices", "summary": "Seleções válidas para contexto app/domínio/link", "permission": "templates:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 332 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/assets", "operationId": "getAssets", "summary": "Listar e fazer upload de ativos autorizados", "permission": "assets:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 333 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/assets", "operationId": "createAssets", "summary": "Listar e fazer upload de ativos autorizados", "permission": "assets:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 333 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/assets/{assetId}", "operationId": "getAssetsAssetId", "summary": "Metadados e exclusão condicionada a referências", "permission": "assets:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 334 }, "idempotency": "none", "ifMatch": "none" }, { "method": "DELETE", "path": "/assets/{assetId}", "operationId": "deleteAssetsAssetId", "summary": "Metadados e exclusão condicionada a referências", "permission": "assets:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A3a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 334 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/analytics/summary", "operationId": "getAnalyticsSummary", "summary": "Totais e indicadores por período/filtros", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 344 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/timeseries", "operationId": "getAnalyticsTimeseries", "summary": "Série com granularidade suportada", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 345 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/breakdown", "operationId": "getAnalyticsBreakdown", "summary": "Dimensões disponíveis e valores agregados", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 346 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/top-links", "operationId": "getAnalyticsTopLinks", "summary": "Ranking paginado", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 347 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/events", "operationId": "getAnalyticsEvents", "summary": "Eventos individuais autorizados e paginados", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 348 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/native", "operationId": "getAnalyticsNative", "summary": "Aberturas, conteúdo e métricas nativas", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 349 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/recovery", "operationId": "getAnalyticsRecovery", "summary": "Etapas e cobertura das recuperações implementadas", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A3c", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 350 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/analytics/campaigns/{campaignId}", "operationId": "getAnalyticsCampaignsCampaignId", "summary": "Métricas vinculadas à campanha", "permission": "analytics:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 351 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/exports", "operationId": "createExports", "summary": "Solicitar exportação de links, eventos ou relatórios", "permission": "exports:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 352 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/exports/{exportId}", "operationId": "getExportsExportId", "summary": "Consultar progresso, expiração e metadados", "permission": "exports:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 353 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/exports/{exportId}/download", "operationId": "getExportsExportIdDownload", "summary": "Download autorizado ou URL temporária conforme política", "permission": "exports:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 354 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/links/{linkId}/qr", "operationId": "getLinksLinkIdQr", "summary": "Gerar QR do endereço público do link em PNG/SVG com opções limitadas", "permission": "qr_codes:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 366 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/qr-codes", "operationId": "getQrCodes", "summary": "Listar/criar configurações persistidas de QR", "permission": "qr_codes:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 367 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/qr-codes", "operationId": "createQrCodes", "summary": "Listar/criar configurações persistidas de QR", "permission": "qr_codes:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 367 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/qr-codes/{qrId}", "operationId": "getQrCodesQrId", "summary": "Consultar QR e estilo salvo", "permission": "qr_codes:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 368 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/qr-codes/{qrId}", "operationId": "updateQrCodesQrId", "summary": "Atualizar nome e estilo do QR; vínculo imutável", "permission": "qr_codes:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 368 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/qr-codes/{qrId}", "operationId": "deleteQrCodesQrId", "summary": "Excluir configuração do QR; imagens distribuídas continuam válidas", "permission": "qr_codes:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 368 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/qr-codes/{qrId}/download", "operationId": "getQrCodesQrIdDownload", "summary": "Baixar arquivo no formato/tamanho permitido", "permission": "qr_codes:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4a", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 369 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/link-batches", "operationId": "createLinkBatches", "summary": "Criação/edição/movimentação/arquivamento/remoção em lote", "permission": "batches:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 377 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/link-batches/{batchId}/items", "operationId": "getLinkBatchesBatchIdItems", "summary": "Resultados por item, paginados", "permission": "batches:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 378 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/imports", "operationId": "createImports", "summary": "Upload/registro de importação CSV/JSON", "permission": "imports:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 379 }, "idempotency": "required", "ifMatch": "none" }, { "method": "POST", "path": "/imports/{importId}/validate", "operationId": "validateImportsImportId", "summary": "Validar e produzir relatório sem gravar links", "permission": "imports:validate", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 380 }, "idempotency": "required", "ifMatch": "none" }, { "method": "POST", "path": "/imports/{importId}/commit", "operationId": "commitImportsImportId", "summary": "Executar importação validada", "permission": "imports:commit", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 381 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/imports/{importId}", "operationId": "getImportsImportId", "summary": "Resumo, estado e erros", "permission": "imports:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 382 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/imports/{importId}/items", "operationId": "getImportsImportIdItems", "summary": "Resultados por linha", "permission": "imports:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 383 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/operations/{operationId}", "operationId": "getOperationsOperationId", "summary": "Consultar operação com autorização do recurso original", "permission": "operations:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 384 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/operations/{operationId}/cancel", "operationId": "cancelOperationsOperationId", "summary": "Cancelar trabalho pendente quando suportado", "permission": "operations:cancel", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A2", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 385 }, "idempotency": "required", "ifMatch": "required" }, { "method": "GET", "path": "/webhooks", "operationId": "getWebhooks", "summary": "Listar/cadastrar destino e assinaturas de eventos", "permission": "webhooks:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 395 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/webhooks", "operationId": "createWebhooks", "summary": "Listar/cadastrar destino e assinaturas de eventos", "permission": "webhooks:create", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "query_or_body_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 395 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/webhooks/{webhookId}", "operationId": "getWebhooksWebhookId", "summary": "Consultar/alterar/desativar destino", "permission": "webhooks:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 396 }, "idempotency": "none", "ifMatch": "none" }, { "method": "PATCH", "path": "/webhooks/{webhookId}", "operationId": "updateWebhooksWebhookId", "summary": "Consultar/alterar/desativar destino", "permission": "webhooks:update", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 396 }, "idempotency": "required", "ifMatch": "required" }, { "method": "DELETE", "path": "/webhooks/{webhookId}", "operationId": "deleteWebhooksWebhookId", "summary": "Consultar/alterar/desativar destino", "permission": "webhooks:delete", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 396 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/webhooks/{webhookId}/rotate-secret", "operationId": "rotateSecretWebhooksWebhookId", "summary": "Rotacionar assinatura com período de transição", "permission": "webhooks:rotate_secret", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 397 }, "idempotency": "required", "ifMatch": "required" }, { "method": "POST", "path": "/webhooks/{webhookId}/test", "operationId": "testWebhooksWebhookId", "summary": "Enviar evento sintético identificado como teste", "permission": "webhooks:test", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 398 }, "idempotency": "required", "ifMatch": "none" }, { "method": "GET", "path": "/webhooks/{webhookId}/deliveries", "operationId": "getWebhooksWebhookIdDeliveries", "summary": "Histórico paginado", "permission": "webhooks:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 399 }, "idempotency": "none", "ifMatch": "none" }, { "method": "GET", "path": "/webhook-deliveries/{deliveryId}", "operationId": "getWebhookDeliveriesDeliveryId", "summary": "Detalhe sanitizado", "permission": "webhooks:read", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 400 }, "idempotency": "none", "ifMatch": "none" }, { "method": "POST", "path": "/webhook-deliveries/{deliveryId}/retry", "operationId": "retryWebhookDeliveriesDeliveryId", "summary": "Reentrega explicitamente autorizada", "permission": "webhooks:retry", "credentials": [ "human", "api_key", "oauth" ], "oauthAvailability": "B1b_after_validation", "resourceScope": "resource_owner_app", "capability": null, "milestone": "A4b", "state": "available_production", "source": { "path": "docs/planejamento/PLANO-01-API-INFRAESTRUTURA-DOCUMENTACAO.md", "line": 401 }, "idempotency": "required", "ifMatch": "required" } ] }