Pular para o conteúdo
AdiosDocumentação
Explorar a documentação

API de início rápido

Comece verificando a saúde da API, depois confirme seu token bearer e o contexto da equipe.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

MétodoCaminhoOperação
GET/v1/healthVerificar a saúde da API
GET/v1/auth/meObter o usuário atual

Verificar a saúde da API

GET /v1/health

Verifique se o processo da API está respondendo.

Autenticação: pública; não exige token bearer.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/health"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Exemplo ilustrativo; não é uma resposta real:

{
  "status": "ok"
}

Obter o usuário atual

GET /v1/auth/me

Retorna seu user_id, perfil, equipes e team_data. O script de resposta salva apenas user_id no ambiente selecionado. Defina team_id manualmente para a equipe ativa na CLI antes de usar um token de diagnóstico.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/auth/me" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.