Pular para o conteúdo principal

Quickstart

Vamos fazer sua primeira interação com a API da QuettaCode. Neste guia rápido, você aprenderá a autenticar e fazer um "Ping" para verificar se tudo está funcionando.

Pré-requisitos​

  • Uma conta ativa na QuettaCode.
  • curl instalado (ou usar Postman/Insomnia).
  • A URL base da API: https://api.quettacode.com

1. Obter Credenciais​

Para começar, você precisa fazer login para obter um token de sessão. Normalmente, você receberá um convite por e-mail ou terá um usuário administrador inicial.

Endpoint: Login​

POST /api/v2/auth/login

Body (JSON):

{
  "email": "[email protected]",
  "password": "sua-senha-segura"
}

Exemplo cURL:

curl -X POST https://api.quettacode.com/api/v2/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "123456"
  }'

Resposta de Sucesso (200 OK):

{
  "token": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "user": {
    "id": "user_123",
    "email": "[email protected]",
    "fullName": "Admin User",
    "role": "ADMIN"
  }
}

Nota: O campo token retornado é o ID da sessão que deve ser enviado no cookie JSESSIONID ou header (dependendo da configuração do cliente). A plataforma usa sessões HTTP.

2. Testar Conexão (Ping)​

Agora que você tem acesso, vamos testar um endpoint público ou autenticado. Vamos usar o endpoint de verificação de saúde ou um endpoint simples de leitura.

GET /api/v1/ping

Exemplo cURL:

curl -X GET https://api.quettacode.com/api/v1/ping

Resposta:

{
  "status": "UP",
  "message": "Pong!"
}

Próximos Passos​

Parabéns! Você fez sua primeira requisição. Agora você pode: