API Documentation

API / Документация / Public / Changelog

StudyHub.AZ API Documentation

Version: 3.1.0 Base URL: https://api.studyhub.az Last Updated: 2025-01-15

Введение

StudyHub.AZ API предоставляет RESTful интерфейс для доступа к функциям платформы StudyHub, включая курсы валют, платежи, сообщения и управление системой.

Возможности

RESTful дизайн API
Несколько методов аутентификации (Bearer Token, API Key, Query Parameter)
Rate limiting для защиты API
Комплексная обработка ошибок
JSON ответы
Поддержка CORS
OpenAPI 3.0.3 спецификация

Быстрый старт

Получите токен API через соответствующий раздел настроек вашей роли
Используйте токен в заголовке Authorization: Bearer YOUR_TOKEN
Начните делать запросы к API

Пример первого запроса

``bash curl -X GET "https://api.studyhub.az/public/currency/rates"``

Разделы документации

Публичные API - Эндпоинты, не требующие аутентификации
Аутентифицированные API - Эндпоинты, требующие токен
Примеры кода - Примеры использования на разных языках
Справочник - Детальная информация об аутентификации, ошибках, rate limiting
История изменений - История версий API

🚀 Начните работу с API

Версия 3.1.0 | Базовый URL: https://api.studyhub.az

📖 Публичные API 💻 Примеры кода 🔐 Аутентификация

🚀 Публичные API

Эндпоинты, доступные без аутентификации. Идеально для получения публичных данных о курсах валют и статусе API.

✓ Currency Rates
✓ API Status
✓ Currency Conversion

Перейти →

🔐 Аутентифицированные API

Эндпоинты, требующие токен доступа. Для работы с защищенными данными: сообщения, платежи, управление токенами.

✓ Messages
✓ Payments
✓ Token Management

Перейти →

💻 Примеры кода

Готовые примеры использования API на популярных языках программирования и инструментах.

✓ cURL
✓ JavaScript
✓ PHP, Python

Перейти →

📖 Справочник

Детальная информация об аутентификации, обработке ошибок, rate limiting и OpenAPI спецификация.

✓ Authentication
✓ Error Codes
✓ OpenAPI Spec

Перейти →

📊 Статистика API

Версия: 3.1.0
Публичных эндпоинтов: 9+
Аутентифицированных: 10+
Формат: JSON

⚡ Быстрые ссылки

🔗 Полезные ресурсы

💡 Полезные советы

📋 Копирование Markdown: Используйте кнопку "📋 Копировать Markdown" в правом нижнем углу для копирования Markdown документации из комментариев PHP файлов.

🔑 Получение токена: Компании получают токены через раздел настроек директора компании. Подробнее см. раздел Аутентификация.

📚 OpenAPI: Используйте OpenAPI спецификацию для импорта в Swagger UI, Postman или другие инструменты тестирования API.