// API docs

API 文档

集成 Tarello 功能所需的一切。从「快速开始」开始,或直接跳到你要使用的功能。

Autenticação

A Tarello usa JWT (JSON Web Tokens) para autenticar todas as chamadas à API. Cada project tem sua própria chave de assinatura, então um JWT do project A não é aceito no project B.

Header de autenticação

Inclua o token no header Authorization:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Obter um JWT

Existem três formas:

  1. Chave de API permanente — gerada no Console, não expira até ser revogada. Use para serviços backend.
  2. Login de usuário — endpoint POST /v1/identity/login retorna um JWT vinculado a um usuário, com expiração de 24h.
  3. Refresh token — usado para renovar o JWT de login sem precisar pedir senha de novo.

Exemplo: login

Request

POST /v1/identity/login
Content-Type: application/json

{
  "email": "ana@exemplo.com",
  "password": "********"
}

Response 200

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "rt_8f4a2b1c...",
  "expires_in": 86400,
  "user": {
    "id": "usr_abc123",
    "email": "ana@exemplo.com",
    "tags": ["admin", "support"]
  }
}

Renovar o token

POST /v1/identity/refresh
Content-Type: application/json

{
  "refresh_token": "rt_8f4a2b1c..."
}

Revogar uma chave

Pelo Console, em Chaves → Revogar. A revogação é imediata em toda a infraestrutura.