Começar

Autenticação

Uma API key abre todos os produtos da sua empresa — como você, nunca mais do que você pode.

Crie uma key

Keys são criadas no Yet, em Preferences → API keys, no endereço da sua empresa (acme.yet.com.br/preferences/keys) — por qualquer pessoa da empresa. Dê um nome — para que ela serve — e copie: ela aparece só esta vez. O Yet guarda apenas os primeiros caracteres, para distinguir uma da outra, e um hash.

Uma API key

yet_acme_6bffe638db8b02483be16f2407d7ddce0aeea792ed9446d6

A key diz de qual empresa ela é — yet_<empresa>_<segredo> — e assim os SDKs e o provider Terraform encontram os endereços da sua empresa só por ela.

Use

Mande no header Authorization, como bearer token, em toda requisição:

bash

curl https://cloud.yet.com.br/v1/me \
  -H "Authorization: Bearer $YET_API_KEY"

Os SDKs, o provider e a CLI leem do ambiente:

bash

export YET_API_KEY=yet_acme_6bffe638…

Quem é uma key

Uma key age como a pessoa que a criou. Faz o que ela pode, em todos os produtos, e nada além:

No Cloud, o papel dela — viewer, developer ou admin, em tudo ou por ambiente — decide o que a key vê e muda.
No Settings e no IAM, só entra a key de quem administra o Settings da empresa.
O que uma key faz fica registrado em nome da pessoa, na atividade do IAM.

Duas coisas exigem uma pessoa logada no Yet, nunca uma key: dar um papel a alguém e criar uma key. Uma key vazada nunca entrega da sua empresa mais do que a pessoa tinha — nem sobrevive à própria revogação.

Endereços

Cada produto responde no seu endereço; a sua key funciona em todos.

Produto	URL base
Cloud	`https://cloud.yet.com.br/v1`
Settings, IAM	`https://<company>.yet.com.br/api/settings`

Num Yet próprio, os mesmos nomes sob o domínio dele: YET_BASE_DOMAIN diz às ferramentas qual.

Revogue uma key

Apague em Preferences → API keys, ou pela API. Os admins da empresa veem as keys de todo mundo em Settings → IAM e revogam qualquer uma — ali ou pela API do IAM. A key para de funcionar na hora.