DocumentaçãoChaves de API
Começar
Chaves de API
Uma chave identifica a tua aplicação perante a API. Guarda-se no teu servidor, como uma palavra-passe.
Como é uma chave
Uma chave começa sempre por lya, seguido do seu tipo. O tipo indica em nome de quem age.
| Prefixo | Tipo | Para |
|---|---|---|
lya_svc_ | Serviço | Uma aplicação ou um servidor do teu espaço de trabalho |
lya_usr_ | Pessoal | Uma pessoa, com os seus próprios direitos |
lya_prt_ | Parceiro | Uma integração construída com a Learnya |
A Learnya guarda apenas uma impressão digital da chave, impossível de ler. Uma chave perdida não se recupera, substitui-se.
Onde a enviar
No cabeçalho Authorization, a seguir a Bearer. Os SDK OpenAI fazem-no por ti. O cabeçalho x-api-key também é aceite.
| Cabeçalho | Exemplo |
|---|---|
Authorization | Bearer lya_svc_… |
x-api-key | lya_svc_… |
Uma chave recusada recebe uma resposta 401, sem indicação do motivo. Assim, um terceiro que experimente chaves não fica a saber nada.
Obter uma chave
As chaves estão disponíveis para os espaços de trabalho Team e para os parceiros. Criamo-la contigo e escolhemos juntos:
- o seu nome, para a reconhecer no teu espaço de trabalho
- o seu âmbito, que tem de incluir llm:invoke para chamar os modelos
- uma data de expiração, se a chave servir um projeto com duração limitada
A chave é-te mostrada uma única vez, quando é criada.
Mantê-la secreta
- Uma chave por aplicação, para poderes desativar uma sem parar as outras
- Numa variável de ambiente ou num cofre de segredos, nunca no repositório de código
- Uma chave revogada deixa de funcionar em menos de um minuto