Chaves de API

As chaves de API são usadas quando seu site, aplicativo ou outro sistema externo precisa solicitar conteúdo ao Contismo.

Elas dão acesso autenticado fora do Studio e devem ser tratadas com segurança.

Tipos de chave

O Contismo aceita chaves GraphQL para sites e aplicativos, e chaves MCP para clientes de IA.

Tipo	Prefixo	Acesso
GraphQL - Somente leitura	`gql_`	Consultar conteúdo via GraphQL
GraphQL - Leitura e gravação	`gqlw_`	Consultar conteúdo e executar mutações GraphQL para modelos de conteúdo, entradas e recursos (criar, atualizar, excluir e mudanças de status)
MCP - Somente leitura	`mcp_`	Ler conteúdo pelo servidor MCP
MCP - Leitura e gravação	`mcpw_`	Criar, atualizar e excluir entradas pelo servidor MCP quando as gravações estão habilitadas

Chaves de leitura e gravação não podem gerenciar membros da equipe, cobrança, webhooks nem outras chaves de API. Chaves GraphQL não funcionam no servidor MCP, e chaves MCP não funcionam no GraphQL.

Criar uma chave de API

Para criar uma nova chave de API:

Vá em Configurações → Chaves de API.
Clique em Criar chave de API.
Digite um nome que ajude a identificar onde a chave será usada.
Escolha um tipo de chave GraphQL ou MCP.
Copie a chave e guarde-a em um lugar seguro.

Usar a chave

Inclua a chave de API no cabeçalho Authorization ao fazer solicitações GraphQL. Envie também o ambiente no cabeçalho X-Environment:

Authorization: Bearer <your-api-key>
X-Environment: <environment-api-id>

Chaves GraphQL somente leitura podem executar consultas. Chaves GraphQL de leitura e gravação também podem executar mutações. Consulte a referência da API GraphQL.

Chaves MCP usam os mesmos cabeçalhos no endpoint do MCP. Configure modelos, rascunhos e gravações nas configurações do MCP e depois consulte a referência do servidor MCP para as ferramentas e um exemplo de cliente.