Desenvolvedor

Desenvolva com a API e os SDKs

7:50 de demonstração

A narração do vídeo é em inglês.

A Toktik Developer API é uma API REST medida, com SDKs oficiais — @toktikhq/sdk-js para JavaScript/TypeScript e toktik para Python. Comece pelo quickstart, autenticação e créditos e depois copie exemplos prontos em cURL, JavaScript e Python.

O que você vai aprender

Gerar uma chave e fazer sua primeira requisição autenticada
Entender escopos, limites de taxa e o modelo de créditos
Usar os SDKs de JavaScript e Python
Ler a documentação: quickstart, endpoints e escopos

Como funciona

Crie uma chave em Settings
No app, abra Settings, depois Developer keys, e crie uma chave só com os escopos de que precisa, como rank:read para rankings. O segredo começa com ttk_live_ e é exibido uma única vez, então guarde-o em uma variável de ambiente. As chaves só acessam rotas de dados, e criar chaves continua sendo uma ação que exige login.
Faça sua primeira requisição
Envie a chave como Authorization: Bearer com o seu segredo ttk_live_. O quickstart da documentação chama o ranking oficial em api.toktikhq.com/v1/rankings/official com board=hourly e region=VN. Um 403 significa que a chave não tem o escopo daquela rota.
Trabalhe dentro dos limites e dos créditos
Cada chave tem um limite de requisições por segundo conforme o plano, de 1 no Free a 150 no Agency. Acima do limite você recebe 429, então espere o Retry-After e tente de novo. Ficar sem créditos retorna 402, que tentar novamente não resolve, e GET /v1/usage mostra seu consumo.
Adicione um SDK oficial
Instale npm i @toktikhq/sdk-js para JavaScript e TypeScript, ou pip install toktik para Python; ambos chamam a mesma API REST v1 com a mesma chave e a mesma carteira de créditos. As páginas Quickstart e API Reference da documentação listam cada endpoint, parâmetro e escopo.

Perguntas frequentes

Quanto custa a API da Toktik?

Não há uma tabela de preços separada para a API. O app web e a API gastam a mesma carteira de créditos no mesmo plano. Uma leitura servida do armazenamento da Toktik custa 1 crédito, uma exportação custa 2,500 créditos, e as chamadas de coleta sob demanda custam mais.

Quais são os limites de taxa da API da Toktik?

Por chave, por segundo: Free 1, Starter 5, Pro 20, Scale 60 e Agency 150. Também há cotas diárias, de 5,000 requisições no Free a 1,200,000 no Agency. Exceder o limite retorna 429 com cabeçalhos que mostram o estado da janela.

A Toktik tem SDKs oficiais?

Sim. O @toktikhq/sdk-js cobre JavaScript e TypeScript, e o pacote toktik cobre Python. Ambos chamam a mesma API REST v1 com a mesma chave.

Qual a diferença entre um 402 e um 403 da API da Toktik?

Um 402 significa que o workspace está sem créditos, então faça uma recarga em vez de tentar de novo. Um 403 significa que a chave é válida, mas não tem o escopo necessário, então conceda-o ou use uma sessão com login. Um 429 é um limite de taxa e pode ser repetido com segurança após esperar.

Ler a documentação da API Todos os guias