Построение запросов
Запросы сделаны из трех компонентов:
- Версия API
- Путь к файлу
- Тип выхода
Для построения правильного запроса Вам нужно отредактировать URL следующим образом:
https://api.yourepo.com/{version}/{resource}.{output_type}
Пример запроса для получения списка участников, которые купили пакет.
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
По умолчанию, запросы являются HTTP GET запросами. Тем не менее, многие методы требуют от Вас отправки данных POST. Как правило, мы будем следовать стандарту всех запросов на чтение, использующих GET и писать запросы, использующие POST.
В дополнение к требуемым параметрам для каждого отдельного метода, Вы также должны отправить свой ключ API.
Если вы используете API сервера, Вам нужно будет отправить secret_key со значением Вашего секретного ключа API.
Версия API
Для каждого запроса Вы должны указать, какую версия API Вы хотите использовать. В настоящее время, по умолчанию, и единственной доступной версией является версия 1.0.
Путь к файлу
Путь к ресурсам будет доступен для Вас в будущей документации.
Форматы данных
YouRepo only supports one data format currently, JSON.
Ответы
Ответ Вашего запроса будет содержать несколько ключевых вещей:
- Код состояния HTTP
Кодсостояния API- Ответное сообщение API
Давайте взглянем на пример запроса:
GET https://api.yourepo.com/1.0/package/buyers?package=com.yourepo.source.package&secret_key=YOUR_SECRET_KEY{
"code": 0,
"response": {
"start": 0,
"limit": 25,
"total": "62",
"page": 1,
"buyers": [
{
"nickname": "member1",
"status": "Completed",
"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member1"
},
{
"nickname": "member2",
"status": "Completed",
"profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member2"
},
.....
]
}
}