// API docs

API-Dokumentation

Alles, was du brauchst, um mit den Tarello-Funktionen zu integrieren. Beginne bei „Erste Schritte" oder spring direkt zur Funktion, die du nutzen wirst.

Primeiros passos

Para começar a usar a Tarello, você precisa de três coisas: uma conta, um projeto e os recursos que o seu produto vai consumir.

1. Crie sua conta

Acesse console.tarello.io/start e faça o cadastro. Você começa no plano grátis: 100 requisições/mês, 500 MB de armazenamento e 1 req/s — sem cartão.

2. Crie um projeto

No Console, clique em Novo projeto. Cada projeto é um ambiente isolado: tem suas próprias chaves de API, seus próprios dados e a região onde você quer hospedar. Você pode ter quantos projetos quiser dentro da organização.

3. Configure a autenticação

A autenticação já vem ativa em todo projeto. Em Autenticação, escolha quais campos usam como identificador (e-mail, celular, usuário) e ative 2FA se quiser. Não precisa codar nada.

4. Crie um recurso

Vá em Recursos do projeto → Novo recurso. Dê um nome (ex: Faturas) e adicione os campos com seus tipos e regras. Assim que salvar, as rotas REST GET /v1/faturas, POST /v1/faturas etc. já ficam ativas.

5. Gere uma chave de API

No menu Chaves do projeto, clique em Nova chave. Copie o JWT gerado — ele só aparece uma vez.

6. Primeira chamada

Teste com um curl:

curl https://api.tarello.io/v1/faturas \
  -H "Authorization: Bearer SEU_JWT_AQUI"

Se tudo estiver certo, você recebe um JSON paginado com a lista de Faturas (vazio se você ainda não criou nenhuma).

Próximos passos