Справочник API

REST API Ordinaut является основным интерфейсом для всех взаимодействий с системой планирования задач. Он построен на FastAPI, который предоставляет автоматическую интерактивную документацию.

Интерактивная документация

Хотя этот справочник предоставляет обзор, вы также можете использовать интерактивную документацию, генерируемую самим API:

Swagger UI: http://localhost:8080/docs
ReDoc: http://localhost:8080/redoc

Базовый URL

Разработка: http://localhost:8080
Производство: https://api.your-domain.com/v1

Общие концепции

Обработка ошибок

API использует стандартные коды состояния HTTP. Ответы об ошибках следуют последовательному формату JSON:

{
  "error": "ValidationError",
  "message": "Недопустимое выражение расписания",
  "details": {
    "field": "schedule_expr",
    "value": "неверный cron"
  },
  "request_id": "req-123456789",
  "timestamp": "2025-01-10T10:00:00Z"
}

Ограничение частоты запросов (Rate Limiting)

Для обеспечения стабильности системы API применяет ограничения по частоте запросов, по умолчанию на основе IP-адреса клиента. Если вы превысите лимит, вы получите ответ 429 Too Many Requests. Проверяйте заголовок Retry-After, чтобы узнать, когда можно отправить следующий запрос.