Chaves de API

Uma chave de API pertence a exatamente um projeto e faz o que os seus escopos indicam. Você pode restringi-la ainda mais a modelos e operações nomeados, ou confiná-la a uma organização.

Chaves públicas e secretas

Há dois tipos, distinguidos pelo prefixo. Uma chave pública (pk_) é segura para ir no navegador. Sozinha, é somente leitura e retorna conteúdo publicado, e um usuário logado acrescenta os escopos do próprio papel. Uma chave secreta (sk_) é para um servidor, e a API rejeita uma em qualquer requisição que carregue o cabeçalho Origin de um navegador. Qualquer dos tipos é criado dentro de um projeto e serve apenas esse projeto.

Escopos

Os escopos definem o tipo de acesso que uma chave tem, como records:read ou executar operações. A verificação é uma lista de permissão, então uma chamada cujo escopo a chave não tem é recusada. Um escopo permite uma chamada e nunca amplia quais linhas uma consulta retorna. Alguns escopos não podem ser mantidos por uma chave pública, e pedir um é recusado quando a chave é criada.

Restringindo a modelos e operações

Dois seletores em uma chave definem quais recursos ela alcança: acesso a modelos e acesso a operações. Ambos têm todos como padrão, ou seja, tudo o que os escopos da chave cobrem, então restringir é opcional. Escolha modelos específicos e os campos tipados de todos os outros modelos desaparecem do schema que essa chave vê, e as chamadas a eles são negadas. Escolha operações específicas e a mutation de uma operação não listada fica ausente do schema da chave, inclusive na introspecção.

Confinamento a uma organização

Uma chave pode ser confinada a uma organização quando é criada. Ela lê essa organização, tudo que está abaixo dela e as linhas compartilhadas em todo o projeto, e grava apenas as próprias. Precisa indicar pelo menos um escopo, não pode emitir chaves e é excluída junto com a organização.

Rotação e alterações posteriores

Rotacionar uma chave mantém o segredo antigo funcionando por 24 horas. Revogar encerra todos os segredos imediatamente. Escopos, modelos permitidos e o nome podem ser editados em uma chave existente e entram em vigor ao salvar. Tipo da chave, confinamento e expiração são fixados na criação.

Leia os detalhes

O guia de chaves de API cobre os dois tipos de chave, seus escopos, a restrição do alcance de uma chave e a rotação.