Для создания ТЗ своими сервисами или системами создания контента мы разработали доступ по АПИ. Ключ доступа привязан к вашему аккаунту и находиться в разделе баланса. Он нужен для идентификации вас в системе.
Все запросы через POST, содержат авторизацию:
Возвращает текущий баланс на счете. Отправка post на url апи:
{
"apikey":"ваш ключи из раздела баланса",
"login":"ваш логин в системе",
"cmd":"GetBalance"
}
Ответ содержит сумму на лицевом счете:
{
"code":200,
"status":"ok",
"balance":"nnnnn"
}
Создает группы и запускает подготовку ТЗ. Все созданные группы можно увидеть в интерфейсе сервиса в разделе быстрое ТЗ. Отправка:
{
"apikey":"ваш ключи из раздела баланса",
"login":"ваш логин в системе",
"cmd":"SetGroupsInWork",
"grps":[{
"id":"Сами придумайте ID группе, будет в ответе как ключ группы",
"keys":[
"Главный ключ группы",
"Тут следующий ключ группы",
"...",
"Тут следующий ключ группы"
]}],
}
Ответ содержит, по id указанному вами, информацию о созданной группе или информацию об ошибке:
{
"code":200,
"status":"ok",
"grps":{
"Придуманный вами id группы":{
"code":200,
"status":"ok",
"gid":"тут id группы уже в сервисе, далее надо запрашивать результат уже по нему",
"new_balance":"Размер нового баланса"
}
}
}
При ошибке "status":"error", "code":500, параметр msg содержит описание ошибки. Верно как для верхнего уровня так и для элементов групп.
Получает или готовое ТЗ или текущий прогресс выполнения. Отправка списком, можно получать сразу по нескольким группам. Если элемент в списке один то получит по этому одному элементу. Отправка:
{
"apikey":"ваш ключи из раздела баланса",
"login":"ваш логин в системе",
"cmd":"GetGroupsResult",
"grps":[
"ID группы в сервисе",
"следующий id группы в сервисе, которые возвращаются при создании группы командой SetGroupsInWork",
"...",
"следующий id группы"
]
}
Ответ содержит, по id группы в сервисе, информацию о прогрессе выполнения:
{
"code":200,
"status":"ok",
"grps":{
"id группы в сервисе":{
"status":"ok",
"code":202,
"percent_ya": 'насколько процентов выполнен анализ топа',
"percent_direct": 'насколько процентов выполнен анализ конкурентов',
"msg":"wait",
}
}
или готовое ТЗ, после успешного запроса и получения вами ТЗ оно храниться на сервисе в течении часа и потом удаляется. Пример ответа с готовым ТЗ:
{
"code":200,
"status":"ok",
"grps":{
"id группы в сервисе":{
"status":"ok",
"code":200,
"result": {Готовое ТЗ},
}
}