Получить информацию о ресурсе
Описание
Получить подробную информацию о конкретном ресурсе.
URL-адрес
Метод: POST
https://example.com/api/v1.1/resources/get
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
| id | int | 1 | Да | Идентификатор ресурса |
Пример запроса
- JSON
- XML
{
"id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
<xml>
<id>1</id>
<token>abcdefghijklmnqrstuvwxyz</token>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"channels": ["email", "push"],
"dbs_ids": [1],
"id": 1,
"name": "Resource",
"trk_domain": "tracking.example.com",
"url": "https://blog.example:8080"
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<channels>email</channels>
<channels>push</channels>
<dbs_ids>1</dbs_ids>
<id>1</id>
<name>Resource</name>
<trk_domain>tracking.example.com</trk_domain>
<url>https://blog.example:8080</url>
</data>
<error>0</error>
<error_text>Successful operation</error_text>t>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| channel | JSON array | Доступные каналы |
| dbs_ids | JSON array | Прикрепленные базы данных |
| id | int | Идентификатор ресурса |
| name | string | Название ресурса |
| trk_domain | string | Домен для отслеживания действий подписчиков |
| url | string | URL-адрес, используемый в ресурсе |
| descr | string | Описание ресурса |