Chave de API do time

Confira se o time tem API

A API do time faz parte do plano Pro do dono. Na página do time, o painel Chave de API mostra API fora do plano do dono quando o plano não inclui API.

Só Dono e Admin geram, trocam e revogam a chave. Os outros membros veem se a chave está ativa, mas não mexem nela.

Gere a chave

Abra o time em Times e desça até Chave de API. Clique em Gerar chave.

A janela Sua nova chave de API mostra a chave completa. Clique em Copiar chave e guarde num lugar seguro: por segurança, ela aparece só agora. Depois, o painel mostra só uma parte da chave.

Copie o ID do time

No topo da página do time, ao lado do nome, fica o ID público. Clique no ícone de cópia ao lado dele. Esse número identifica o time nas chamadas da API.

Crie links por código

Envie um POST para /api/v1/teams/ID_DO_TIME/links com a chave no cabeçalho Authorization: Bearer. O corpo leva a url de destino e, se quiser, um title:

curl -X POST "https://encurtee.me/api/v1/teams/ID_DO_TIME/links" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://exemplo.com/oferta", "title": "Oferta de setembro"}'

A resposta traz o link curto pronto em data.short_url. O link entra na lista do time e aparece como criado pelo dono do time. Ele conta na cota de links do time, como os links criados no painel.

Para testar a chave antes, use GET /api/v1/teams/ID_DO_TIME/ping. Todos os endereços, erros e exemplos estão na documentação da API do time, também aberta pelo link Documentação no painel da chave.

Acompanhe o uso

Cada chamada com a chave gasta tokens da cota mensal do time. O painel Chave de API mostra os tokens usados no mês e, logo abaixo, quantos tokens cada requisição gasta e quantas requisições cabem por intervalo de tempo. Perto do fim da cota, aparece o aviso Perto do limite de tokens do mês.

O mesmo número aparece no cartão Uso da API no mês, no topo da página do time.

Troque ou revogue a chave

O time tem uma chave ativa por vez.

• Gerar nova chave cria outra chave e desativa a anterior na hora, sem pedir confirmação. Atualize suas integrações logo em seguida.
• Revogar desliga a chave. As integrações que usam essa chave param de funcionar na hora. Você pode gerar outra depois.