Acesso antecipadoSó por convite, e os SDKs ainda não foram publicados.Pedir um convite
Ir para o conteúdo
Docs

Chaves

As chaves de ingestão só escrevem e são públicas de propósito; as chaves de servidor, de leitura e de administração ficam num servidor.

Uma chave (key) pertence a um projeto e tem um de quatro escopos. O prefixo diz qual.

EscopoPrefixoNome no painelO que ela pode fazerOnde ela fica
Ingestãolyr_ing_Send eventsAcrescentar eventos, mais nadaDentro do seu app ou da sua página web
Servidorlyr_srv_Send events from a serverAcrescentar eventos, mais nada. Os eventos dela são verificados.Só no seu backend. Mantenha em segredo.
Leituralyr_read_Read eventsConsultar eventosNum servidor ou num script. Mantenha em segredo.
Administraçãolyr_adm_Full accessEnviar e consultar eventos, para tarefas de administraçãoNum servidor. Mantenha em segredo.

Uma chave de leitura consulta os eventos do seu projeto pela API de leitura: de um script, de um notebook ou de um agente num servidor. Ela lê tudo o que o projeto guarda, então nunca vai num app ou numa página web.

Uma chave de servidor envia eventos a partir do seu backend: pelo SDK de Node, Python, Go ou JVM, ou com curl. Assim como uma chave de ingestão, ela não lê, mas é um segredo: os eventos que ela envia são marcados como verificados, porque só os seus servidores a têm, e a cota diária de um endereço não se aplica a ela. Ela nunca vai num app ou numa página web. Apps e páginas web usam a chave de ingestão.

Por que uma chave de ingestão pode ser pública

Uma chave de ingestão vai dentro do binário do seu app ou da sua página web, então parta do princípio de que qualquer um pode lê-la. Tudo bem, porque ela só pode acrescentar eventos ao seu projeto: não pode ler, alterar nem apagar nada. O projeto em que um evento cai sempre vem da chave, nunca do evento. Para limitar abusos, cada projeto tem um limite de taxa (60.000 eventos por minuto por padrão), e um lote acima do limite recebe 429. Um endereço também só pode enviar com ela uma cota diária do mês da organização.

O outro lado: qualquer pessoa com a chave de ingestão pode enviar eventos como os do seu app, então eles não são verificados, a menos que venham do seu app da Apple e a Apple prove isso com App Attest, ou do seu app Android e o celular prove isso com Key Attestation. Esses eventos também não contam para a cota diária.

As chaves são mostradas uma vez

O Lyrelog guarda apenas um hash SHA-256 de cada chave. Você vê a chave uma única vez, quando a cria: copie-a nesse momento. Chaves perdidas não podem ser recuperadas; crie uma nova.

Criar e revogar

As chaves ficam na página API keys do projeto: Settings, depois API keys, ou ⌘ K e API keys. Só os proprietários podem criá-las e revogá-las.

  • Um projeto tem no máximo 20 chaves ativas. Revogue uma para criar outra.
  • As chaves não expiram: uma chave funciona até ser revogada, ou até o seu projeto ser apagado.
  • Criar uma chave Send events from a server, Read events ou Full access exige um login recente (nos últimos 10 minutos). As chaves Send events não exigem.
  • Quando alguém sai de uma organização ou é removido dela, as chaves de leitura e de acesso total que essa pessoa criou são revogadas. As chaves de ingestão ficam, porque os apps já publicados enviam com elas. As chaves de servidor também ficam, porque os seus servidores enviam com elas: se a pessoa que saiu viu alguma, revogue-a e substitua-a.
  • Todos na organização veem a lista de chaves e quando cada uma foi usada pela última vez.

Uma chave revogada para de funcionar na hora; conte com até um minuto. Um SDK que recebe 401 ou 403 para de enviar até o app ser reiniciado, e mantém os eventos que estão na fila.