Pular para conteúdo

Autenticação API

A API do omegaUp usa autenticação baseada em token para acesso seguro a endpoints protegidos.

Fluxo de autenticação

sequenceDiagram
    participant Client
    participant API
    participant Database

    Client->>API: POST /api/user/login/
    API->>Database: Validate credentials
    Database-->>API: User data
    API->>API: Generate auth_token
    API-->>Client: Return auth_token
    Client->>API: Request with ouat cookie
    API->>API: Validate token
    API-->>Client: Protected resource

Obtendo um token de autenticação

Ponto final de login

Solicitação: 

POST https://omegaup.com/api/user/login/
Content-Type: application/json

{
  "usernameOrEmail": "user@example.com",
  "password": "password"
}
Resposta: 
{
  "status": "ok",
  "auth_token": "abc123def456..."
}

Usando o token

Inclua o token em um cookie chamado ouat (omegaUp Auth Token):

curl -X POST https://omegaup.com/api/problem/create/ \
  -H "Cookie: ouat=abc123def456..." \
  -H "Content-Type: application/json" \
  -d '{"title": "My Problem", ...}'
Alternativamente, inclua como parâmetro POST:

curl -X POST https://omegaup.com/api/problem/create/ \
  -d "ouat=abc123def456..." \
  -d "title=My Problem" \
  ...

Gerenciamento de sessão

Sessão Ativa Única

omegaUp suporta apenas uma sessão ativa por vez. O login programaticamente invalidará a sessão do navegador e vice-versa.

Considerações de segurança

  • Somente HTTPS: toda comunicação de API deve usar HTTPS
  • Armazenamento de tokens: armazene tokens com segurança, nunca se comprometa com o controle de versão
  • Expiração do Token: Os tokens podem expirar; lidar com erros de autenticação normalmente

Documentação Relacionada