Запросы к API

​

API токены

• Все запросы идут только через API токены
• Токены живут вечно, отозвать можно в любой момент

​

Сервисные пользователи

• Все запросы идут через сервисных пользователей
• Сервисный пользователь - это такой же сотрудник школы с настроенными вами правами
• Чтобы создать API ключ - необходимо создать сотрудника (сервисного пользователя), указать права и скопировать его API token

​

Создание сервисного пользователя

1. Создайте сотрудника - В панели администратора школы создайте нового сотрудника с нужными правами доступа.
2. Настройте права - Укажите необходимые права для сервисного пользователя в зависимости от задач интеграции.
3. Получите API токен - Скопируйте API токен созданного сервисного пользователя для использования в запросах.

​

Использование API токена

​

Безопасность хранение токенов

• Никогда не храните API токены в коде приложения
• Используйте переменные окружения
• Не коммитьте токены в репозиторий

​

Управление сервисными пользователями

• Создавайте отдельных сервисных пользователей для разных задач
• Регулярно проверяйте права доступа
• Отзывайте токены при необходимости

​

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

• Всегда проверяйте статус ответа
• Логируйте ошибки аутентификации
• Реализуйте retry логику для временных ошибок

⚠️ Важно: API токен предоставляет доступ к данным школы. Храните его в безопасном месте и не передавайте третьим лицам.

​

Структура запроса

​

Заголовки запроса

curl --location 'https://api.exode.biz/saas/v2/user/create' \
--header 'Seller-Id: {{ sellerId }}' \
--header 'School-Id: {{ schoolId }}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ token }}' \
--data-raw '{
  "email": "[email protected]",
  "phone": "+1234567890",
  "tgId": 123456789,
  "profile": {
    "firstName": "Firstname",
    "lastName": "Lastname"
  }
}'

​

Примеры ответов

{
    "success": true,
    "code": 201,
    "payload": {
        "id": 1,
        "activated": true,
        "tgId": null,
        "email": "[email protected]",
        "phone": null,
        "createdAt": "2025-01-01T10:30:00Z",
        "status": "active",
        "profile": {
            "firstName": "Firstname",
            "lastName": "Lastname"
        },
    }
}

​

Структура ответа

Успешный ответ

Ошибка

​

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

try {
    const response = await axios.post(url, data, { headers });
    console.log('Успех:', response.data);
} catch (error) {
    if (error.response?.status === 401) {
        console.error('Ошибка аутентификации - проверьте токен');
    } else if (error.response?.status === 400) {
        console.error('Ошибка валидации:', error.response.data.error.details);
    } else {
        console.error('Неизвестная ошибка:', error.message);
    }
}

if ($httpCode === 200) {
    $result = json_decode($response, true);
    echo "Успех: " . json_encode($result, JSON_PRETTY_PRINT);
} elseif ($httpCode === 401) {
    echo "Ошибка аутентификации - проверьте токен";
} elseif ($httpCode === 400) {
    $error = json_decode($response, true);
    echo "Ошибка валидации: " . json_encode($error['error']['details']);
} else {
    echo "Неизвестная ошибка: HTTP $httpCode";
}

try:
    response = requests.post(url, headers=headers, json=data)
    response.raise_for_status()
    result = response.json()
    print(f"Успех: {json.dumps(result, indent=2)}")
except requests.exceptions.HTTPError as e:
    if e.response.status_code == 401:
        print("Ошибка аутентификации - проверьте токен")
    elif e.response.status_code == 400:
        error_data = e.response.json()
        print(f"Ошибка валидации: {error_data['error']['details']}")
    else:
        print(f"Неизвестная ошибка: {e}")