TenkaTenka
Войти

Центр помощи Tenka › Раздел разработчика › Аутентификация

Часть этого контента пока на португальском — перевод на ваш язык в работе.

Аутентификация

Ключ на аккаунт, scope на ключ, авторство на пользователя.

Ключ идентифицирует АККАУНТ (все возвращаемые данные — только его) и несёт scope: чтение или чтение и запись. Запись требует ответственного пользователя на ключе и заголовка Idempotency-Key в POST — повтор того же POST с тем же ключом идемпотентности не создаёт дважды. Для людей, входящих через браузер, путь — корпоративный вход (SSO/SAML) или подключённое приложение (OAuth), а не API-ключ.

Como mandar a chave

A chave vai em um dos dois cabeçalhos abaixo, em toda chamada. Se os dois vierem, vale o Authorization.

CabeçalhoValorDescrição
AuthorizationBearer <chave>Forma recomendada.
X-API-Key<chave>Alternativa para ferramentas que não montam Bearer.

Escopos

Escopo da chaveDescrição
READLê todos os recursos da conta. POST, PUT, PATCH e DELETE respondem 403.
READ_WRITELê e grava. Exige usuário responsável na chave: toda escrita fica na trilha com o nome dele.

Identidade da chave

A chave é emitida no nome de uma pessoa ativa da conta e vale o que a tela dela mostra. Quando a identidade fica irregular (pessoa desligada, chave sem dono), a conta decide se a API só avisa — nos cabeçalhos X-Tenka-Aviso e Warning — ou recusa com 403.

Erros de autenticação

HTTPMensagem (campo erro)Quando acontece
401chave de API ausente ou inválidaSem cabeçalho de chave, chave revogada ou digitada errada.
401chave sem empresa vinculadaA chave existe mas não está ligada a uma conta. Gere outra em Configurações › API.
403conta de demonstração: a API pública está desligada na vitrineA chamada veio para a conta de demonstração: lá a API pública fica desligada.
403identidade da chave de API irregularA conta recusa chaves com identidade irregular (pessoa desligada ou chave sem dono). O corpo traz motivo e comoResolver.
429limite de requisições excedido (120/min)Passou do limite por minuto da chave. Espere o Retry-After.
403esta chave é somente leitura — gere uma chave com escopo de escritaEscrita com chave de escopo somente leitura.
409a chave não tem usuário responsável; recrie a chave em Configurações → API para que os registros criados tenham autoriaA chave de escrita não tem usuário responsável: sem autoria, nada é gravado.