Começar

A API do HotLearn deixa outros sistemas usarem uma conta do HotLearn: um LMS que importa as apostilas para os cursos da escola, um assistente de IA que lê o acervo, um script que confere o saldo de créditos. É a mesma API para todos, com autorização padrão (OAuth 2.1) e permissões finas, os escopos.

Duas formas de acessar#

Para quê	Como	Chave
Aplicativo usado por várias contas (um LMS, um servidor MCP, um parceiro)	O dono da conta autoriza o aplicativo numa tela do HotLearn (Autorização)	Chave de 1 hora, renovada sozinha
Uso próprio (scripts, um assistente de IA no seu computador)	O dono cria a chave em Integrações, no painel (Chaves pessoais)	Chave pessoal, com validade escolhida

Nos dois casos a chave vai no mesmo cabeçalho:

Authorization: Bearer {chave}

Primeira chamada em 5 minutos#

1. Entre no HotLearn como dono da conta e abra Integrações no menu.
2. Em Chaves pessoais, crie uma chave com Ver o plano e o saldo de créditos marcado. Copie a chave: ela aparece uma vez só.
3. Rode:

export HOTLEARN_KEY="cole-a-chave-aqui"

curl https://hotlearn.com.br/api/v1/me \
  -H "Authorization: Bearer $HOTLEARN_KEY"

A resposta traz a conta, o plano, a situação da assinatura e o saldo de créditos. Os campos estão na Referência.

Cadastrar um aplicativo#

Um aplicativo que vai ser usado por outras contas precisa de cadastro no HotLearn. Escreva para contatos@estudiosite.com e informe:

• nome do aplicativo (aparece na tela de autorização);
• endereço de volta depois da autorização, sempre https. Pode ser um padrão de subdomínio, como https://*.seudominio.com/hotlearn/retorno, quando cada cliente tem o próprio subdomínio;
• se o aplicativo atende várias escolas (ou clientes) numa mesma conta. Nesse caso, o external_id passa a ser obrigatório na autorização;
• escopos que o aplicativo vai pedir (Escopos);
• se roda num servidor (recebe um segredo) ou no aparelho da pessoa (sem segredo, só PKCE).

Você recebe o client_id e, para aplicativo de servidor, o client_secret. O segredo é mostrado uma única vez: guarde-o como senha.

Endereços#

O quê	Endereço
API	https://hotlearn.com.br/api/v1
Tela de autorização	https://hotlearn.com.br/oauth/authorize
Troca e renovação de chaves	https://hotlearn.com.br/oauth/token
Revogação	https://hotlearn.com.br/oauth/revoke
Descoberta automática	https://hotlearn.com.br/.well-known/oauth-authorization-server
Especificação OpenAPI	https://hotlearn.com.br/api/v1/openapi.json

Convenções#

• Respostas em JSON (UTF-8). Um item vem em data; listas vêm em { "data": [...], "next_cursor": "..." }.
• Datas em ISO 8601, com fuso.
• Idioma dos textos: locale na query (pt_BR, en, es) ou o cabeçalho Accept-Language. Sem nenhum dos dois, português.
• Erros em application/problem+json, com um code que não muda. Decida pelo code, não pelo texto (Erros e limites).

O que a API oferece#

Versão 1.0 beta:

• descoberta, autorização, renovação e revogação;
• GET /me e a própria conexão (GET/PUT /connection);
• acervo: lista de produtos (acervo, biblioteca e criações), detalhe com o sumário dos capítulos, prévia em PDF, capa, categorias e licença. A lista e as categorias também servem a vitrine pública, sem conta;
• aquisições: adquirir produtos com os créditos da conta (com repetição segura) e o histórico;
• materiais: os materiais de cada produto, a apostila em HTML de lição, Markdown, JSON e PDF (inteira ou por capítulo), o pacote do curso SCORM e as provas (Materiais e arquivos);
• publicações: registrar o que virou curso ou aula do seu lado (aparece para a escola em Integrações);
• atalhos: o botão "Enviar para…" no HotLearn, que abre a tela certa do seu aplicativo (Conexão), e o link de entrada já logado (POST /login-links);
• assinar pelo aplicativo: quem ainda não tem conta passa pelo cadastro do HotLearn e volta para autorizar (signup=1, em Autorização).
• créditos pelo uso: algumas operações pesadas podem consumir créditos da conta; consulte a tabela da sua chave em GET /usage (Créditos e limites de uso).

Na fase beta, detalhes ainda podem mudar. As mudanças depois do lançamento ficam em Novidades.