Catalisa.Building Blocks
Catálogo/CMS/API

API do CMS

42 endpoints em 7 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

45 endpoints

Catálogo e espaços

/cms/api/v15
  • GET/cms/api/v1/catalogCatálogo fechado de componentes e sua versãoCMS_READ
  • GET/cms/api/v1/spacesLista os espaços da organizaçãoCMS_READ
  • POST/cms/api/v1/spacesCria um espaçoCMS_EDITOR
  • GET/cms/api/v1/spaces/:keyUm espaçoCMS_READ
  • PATCH/cms/api/v1/spaces/:keyAtualiza nome, locales, allowlists e slotsCMS_EDITOR

Conteúdo

/cms/api/v1/spaces7
  • GET/cms/api/v1/spaces/:key/content-typesTipos customizados do espaçoCMS_READ
  • POST/cms/api/v1/spaces/:key/content-typesCria ou versiona um tipoCMS_EDITOR
  • GET/cms/api/v1/spaces/:key/entriesLista entradas (?placement=, ?type=)CMS_READ
  • POST/cms/api/v1/spaces/:key/entriesCria entradaCMS_EDITOR
  • GET/cms/api/v1/spaces/:key/entries/:idUma entradaCMS_READ
  • PATCH/cms/api/v1/spaces/:key/entries/:idAltera entradaCMS_EDITOR
  • DELETE/cms/api/v1/spaces/:key/entries/:idRemove (soft delete)CMS_EDITOR

Documentos legais

/cms/api/v1/spaces3
  • GET/cms/api/v1/spaces/:key/legal-documentsRascunhos, cada um com published (a versão que o app tem)CMS_READ
  • PUT/cms/api/v1/spaces/:key/legal-documents/:docKeyGrava o rascunho de um documentoCMS_EDITOR
  • DELETE/cms/api/v1/spaces/:key/legal-documents/:docKeyTira do rascunho (sai do app no próximo release)CMS_EDITOR

Tema e strings

/cms/api/v1/spaces8
  • GET/cms/api/v1/spaces/:key/themeTema, tokens derivados e avisos de contrasteCMS_READ
  • PUT/cms/api/v1/spaces/:key/themeGrava o temaCMS_EDITOR
  • GET/cms/api/v1/spaces/:key/stringsStrings (?locale=)CMS_READ
  • PUT/cms/api/v1/spaces/:key/strings/:localeGrava em lote (até 500) — **só chave e valor**CMS_EDITOR
  • PUT/cms/api/v1/spaces/:key/strings/:locale/protectionLiga/desliga a proteção e define a regraCMS_SECURITY_APPROVER
  • GET/cms/api/v1/spaces/:key/approvalsSolicitações pendentesCMS_READ
  • POST/cms/api/v1/spaces/:key/approvals/:id/approveAprova (autor ≠ aprovador)CMS_SECURITY_APPROVER
  • POST/cms/api/v1/spaces/:key/approvals/:id/rejectRejeita com motivoCMS_SECURITY_APPROVER

Releases, preview e chaves

/cms/api/v113
  • GET/cms/api/v1/spaces/:key/releasesHistóricoCMS_READ
  • POST/cms/api/v1/spaces/:key/releasesPublicaCMS_PUBLISHER
  • GET/cms/api/v1/spaces/:key/releases/currentRelease corrente com manifestoCMS_READ
  • GET/cms/api/v1/spaces/:key/releases/:versionUm releaseCMS_READ
  • POST/cms/api/v1/spaces/:key/releases/:version/rollbackRepublica como versão novaCMS_PUBLISHER
  • POST/cms/api/v1/spaces/:key/preview-tokensToken de preview (1–60 min), devolve jtiCMS_EDITOR
  • DELETE/cms/api/v1/spaces/:key/preview-tokens/:jtiRevoga o token antes do expCMS_EDITOR
  • GET/cms/api/v1/spaces/:key/delivery-keysChaves do app (sem o segredo)CMS_READ
  • POST/cms/api/v1/spaces/:key/delivery-keysEmite chave (segredo sai **uma vez**)CMS_PUBLISHER
  • DELETE/cms/api/v1/spaces/:key/delivery-keys/:idRevogaCMS_PUBLISHER
  • GET/cms/api/v1/signing-keysChaves públicas da organizaçãoCMS_READ
  • POST/cms/api/v1/signing-keys/rotateRotaciona a chave de assinaturaCMS_PUBLISHER
  • GET/cms/api/v1/spaces/:key/analyticsContagens e CTR (?entryId=&from=&to=)CMS_READ

Entrega (o aplicativo)

/cms/delivery/v17
  • GET/cms/delivery/v1/spaces/:key/manifestManifesto assinado; ETag forte e 304
  • POST/cms/delivery/v1/spaces/:key/capabilitiesEstado das chaves de manifest.capabilities, com o aviso resolvido; no-store
  • GET/cms/delivery/v1/keysChaves públicas da organização da chave apresentada
  • GET/cms/delivery/v1/spaces/:key/keysO mesmo, com o espaço no caminho
  • GET/cms/delivery/v1/spaces/:key/assets/:fileIdRedireciona (302) para a URL fresca do asset
  • GET/cms/delivery/v1/spaces/:key/previewRascunho, com X-CMS-Preview-Token
  • POST/cms/delivery/v1/spaces/:key/eventsLote de até 100 eventos (202)