Public Partner API
Это внешнее публичное API для партнёров Яндекс Недвижимости. На текущий момент позволяет получать список звонков. В будущем может быть расширено.
Строится на основе протокола HTTP / REST, данные возвращаются в формате JSON.
Формат запроса:
curl -X GET \
-H 'accept: application/json' \
-H 'X-Authorization: Vertis public-partner-ak0hmqjjk1thu3eutxy8hd1i56mhprpfbb6575qw' \
-H 'Authorization: OAuth $oauth_token' \
'https://api.realty.yandex.net/2.0/publicPartner/calls?clientId=...&agencyId=...&fromDate=...&toDate=...&pageNum=...&pageSize=...'
Формат ответа:
{
"totalCalls": ...,
"totalPages": ...,
"calls": [
{
"timestamp": ...,
"objectName": ...,
"incomingPhone": ...,
"internalPhone": ...,
"waitDuration": ...,
"callDuration": ...,
"revenue": ...,
"objectType": ...,
"campaignTariff": ...,
"clientTariff": ...
},
...
]
}
Авторизация
Чтобы воспользоваться API, нужно получить OAuth-токен
- Запустите браузер, авторизуйтесь на Яндексе тем логином, который используется для доступа в личный кабинет Яндекс.Недвижимости
- Откройте ссылку:
https://oauth.yandex.ru/authorize?response_type=token&client_id=aa4eae0f50244d9aae9c864b349e1859
Нужно разрешить доступ, после чего появится последовательность из букв и цифр. Это и есть OAuth-токен.
Параметры запроса
|
параметр |
обязательный? |
описание |
|
$oauth_token |
обязательный |
OAuth-токен, см. выше про авторизацию |
|
client_id |
обязательный |
ID клиента (партнёра) в Балансе Яндекса |
|
agency_id |
опциональный |
ID агентства в Балансе Яндекса |
|
fromDate, |
обязательные |
Диапазон дат для выбора звонков. Формат `yyyy-mm-dd` |
|
pageNum, |
опциональные |
Разбивка ответа на страницы: pageNum - номер страницы (по умолчанию 0), pageSize - сколько звонков выдавать на странице ответа (по умолчанию 100) |
Поля ответа
|
атрибут |
описание |
|
totalCalls |
Сколько всего звонков найдено |
|
totalPages |
Сколько всего страниц |
|
calls |
Список звонков (на текущей странице, см. pageNum в запросе) |
Атрибуты звонка (внутри calls) соответствуют полям/столбцам, которые возвращаются в excel-файле в Партнёрке.
Пример
Запрос:
curl -X GET \
-H 'accept: application/json' \
-H 'X-Authorization: Vertis public-partner-ak0hmqjjk1thu3eutxy8hd1i56mhprpfbb6575qw' \
-H 'Authorization: OAuth xxxxxxxxxxxxxxxxxxxxxxxxxxx' \
'https://api.realty.yandex.net/2.0/publicPartner/calls?clientId=12345&agencyId=12345&fromDate=2024-10-01&toDate=2024-10-30&pageNum=0&pageSize=10'
Ответ:
{
"totalCalls": 14,
"totalPages": 2,
"calls": [
{
"timestamp": "2024-10-16 10:04:00",
"objectName": "Такой-то ЖК",
"incomingPhone": "+79111234567",
"internalPhone": "+79211234567",
"waitDuration": "00:00:03",
"callDuration": "00:00:40",
"revenue": 250000,
"objectType": "Новостройка",
"campaignTariff": "Базовый",
"clientTariff": "Базовый"
},
...
]
}