Справочник API

Полная документация API с примерами, конечными точками и фрагментами кода для интеграции с услугами TechRam.

Скоро: Наша комплексная документация API в настоящее время находится в разработке. Мы предоставим наш полный API как можно скорее. Следите за обновлениями!

1. Введение

API TechRam позволяет разработчикам интегрировать услуги TechRam в свои приложения. Наш RESTful API предоставляет программный доступ к функциональности TechRam, позволяя создавать пользовательские интеграции и автоматизировать рабочие процессы.

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

2. Аутентификация

Все запросы API требуют аутентификации с использованием API-ключей. Включите ваш API-ключ в заголовки запроса:

Authorization: Bearer YOUR_API_KEY

API-ключи могут быть сгенерированы из панели управления вашего аккаунта TechRam. Храните ваши API-ключи в безопасности и никогда не раскрывайте их в клиентском коде или публичных репозиториях.

3. Базовый URL

Все запросы API должны быть отправлены на следующий базовый URL:

https://api.techramllc.com/v1

Все конечные точки относительны к этому базовому URL. Например, для доступа к конечной точке проектов вы бы использовали:

https://api.techramllc.com/v1/projects

4. Конечные Точки API

API TechRam предоставляет следующие конечные точки:

Проекты

GET /projects

Получить список всех проектов, связанных с вашим аккаунтом.

Создать Проект

POST /projects

Создать новый проект. Обязательные параметры:

Параметр	Тип	Обязательно	Описание
name	string	Да	Название проекта
description	string	Нет	Описание проекта

5. Формат Запроса и Ответа

Формат Запроса

Все запросы должны включать следующие заголовки:

                    Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
                

Тела запросов должны быть закодированы в JSON.

Формат Ответа

Все ответы возвращаются в формате JSON. Типичный успешный ответ:

                    {
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}
                

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

API использует стандартные коды состояния HTTP для указания успеха или неудачи:

200 OK: Запрос успешен
201 Created: Ресурс успешно создан
400 Bad Request: Неверные параметры запроса
401 Unauthorized: Требуется аутентификация или неверный API-ключ
404 Not Found: Ресурс не найден
500 Server Error: Внутренняя ошибка сервера

Ответы об ошибках включают поле сообщения с деталями о том, что пошло не так.

7. Ограничение Скорости

Для обеспечения справедливого использования API реализует ограничение скорости:

Стандартные планы: 100 запросов в минуту
Премиум планы: 500 запросов в минуту
Корпоративные планы: Пользовательские лимиты

Информация об ограничении скорости включена в заголовки ответов. Если вы превысите лимит, вы получите ответ 429 Слишком Много Запросов.

8. Примеры Кода

Пример JavaScript

                    fetch('https://api.techramllc.com/v1/projects', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));
                

Пример PHP

                    $ch = curl_init('https://api.techramllc.com/v1/projects');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer YOUR_API_KEY',
  'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
                

9. Поддержка и Ресурсы

Для дополнительной помощи и ресурсов:

Нужна Помощь? Наша команда поддержки доступна 24/7. Свяжитесь с нами по info@techramllc.com для вопросов, связанных с API.