Документация API

Главная / Документация API

Документация к API

С помощью API, Вы можете создавать приложения для публикации объявлений на нашем сайте.

Текущая версия - 1.0. Для доступа к api скопируйте ключ из личного кабинета. Ключ доступа выдается всем зарегистрированным пользователям автоматически.

Добавление объявления на сайт

Метод "add"

Создает объявление. Принимает запросы в формате JSON

Структура запроса:

{
    "method":"add", /* required */
    "params":{
        "country":0, /* required */
        "city":0, /* required */
        "section":"auto", /* required */
        "category":24, /* required */
        "days":365, /* required */
        "type":1, /* required */
        "contact":"Светлана", /* required */
        "telephone":"123-13-13", /* required */
        "title":"Audi", /* required */
        "description":"машина", /* required */
        "url":"https://oyoo.ru/", /* optional */
        "pricetype":1, /* required */
        "price":780000.50, /* required */
        "currency":35, /* required */
        "images":[ /* optional */
            {
                "imageData":"iVB...", /* required */
                "originalName":"car.png" /* required */
            }
        ]
    },
    "autoOptions":{ /* optional for "auto" */
        "brand":10, /* optional */
        "model":20, /* optional */
        "year":2017, /* optional */
        "mileage":3000.78, /* optional */
        "body":1, /* optional */
        "customs":1, /* optional */
        "state":1, /* optional */
        "color":15, /* optional */
        "motor":2, /* optional */
        "rudder":2, /* optional */
        "transmission":1 /* optional */
    }
}

Параметр	Тип	Описание	Обязательный
Структура JSON
method	string	значение "add" - создание объявления	да
Структура params
Обязательные поля
country	integer	Номер страны. Список значений	да
city	integer	Номер города. Доступные города для стран: список значений	да
section	string	Главный раздел объявлений. список значений	да
category	integer	Номер категории. список значений	да
days	integer	Срок публикации объявления. От 7 до 365 дней	да
type	Тип	Тип объявления. cписок значений	да
contact	string	Контактное лицо	да
telephone	string	Телефон. В любом понятном для посетителя формате	да
title	string	Название товара/услуги. Не более 100 символов	да
description	string	Текст объявления	да
url	string	Адрес сайта с дополнительной информацией о товаре/услуге. Полный адрес c http:// или https://	нет
pricetype	integer	Тип стоимости cписок значений	да
currency	integer	В какой валюте указана цена cписок значений	да
price	number	Цена - целое или дробное значение	да
Структура images
Добавление изображений к объявлению. Не обязательное поле. На размер картинок по высоте и ширине ограничений нет
imageData	string	Изображение, закодированное в base64	да, при наличии изображения
originalName	string	Имя оригинального файла. Расширение должно быть jpg, jpeg, png или gif	да, при наличии изображения
Структура autoOptions
Дополнительные поля для раздела "Легковые автомобили" (категория №24)
brand	integer	Номер брэнда на сайте список значений	нет
model	integer	Номер модели на сайте список значений	нет
year	integer	Год выпуска. От 1885 до 2018	нет
mileage	number	Пробег	нет
body	integer	Номер типа кузова на сайте список значений	нет
customs	integer	Таможня список значений	нет
state	integer	Состояние список значений	нет
color	integer	Цвет кузова список значений	нет
motor	integer	Тип двигателя список значений	нет
rudder	integer	Руль список значений	нет
transmission	integer	Коробка передач список значений	нет

Примеры на PHP

Добавление объявления с фото в раздел "Недвижимость"

<?php
$token = '';
$url = 'https://oyoo.ru/api/v1/';
$headers = array(
   "Authorization: Bearer $token",                    
   "Content-Type: application/json; charset=utf-8"    
);

$originalName = 'example.png';

$imagedata = file_get_contents($originalName);
$imagebase64 = base64_encode($imagedata);

$params = array(
   'method' => 'add', /* новое объявление */                              
   'params' => array( 
        'country' => 46, /* Россия */
        'city' => 11494, /* Москва */
        'section' => 'realty', /* Недвижимость */
        'category' => 223, /* Квартиры » Вторичный рынок */
        'days' => 365, /* срок размещения дней */           
        'type' => 1, /* Продам */                     
        'contact' => 'Светлана', /* Контактное лицо */
        'telephone' => '(499) 123-13-13', 
        'title' => '3-х комнатная полногабаритная квартира площадью 75,7 кв.м', /* заголовок */
        'description' => 'Квартира в районе пл. Станиславского...', /* текст объявления */
        'pricetype' => 1, /* Фиксированная */
        'price' => 4600000, /* цена */
        'currency' => 35, /* Российский рубль */
        'images' => array( /* Optional */
             array(
                'imageData' => $imagebase64, // base64Binary
                'originalName' => $originalName                             
             )                        
        )       
   )
);
$body = json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
$streamOptions = stream_context_create(array(
   'http' => array(
      'method' => 'POST',
      'header' => $headers,
      'content' => $body
   )
));
$result = file_get_contents($url, 0, $streamOptions);

echo $result; 
?>

Добавление объявления в раздел "Транспорт"

<?php
$token = '';
$url = 'https://oyoo.ru/api/v1/';
$headers = array(
   "Authorization: Bearer $token",                    
   "Content-Type: application/json; charset=utf-8"    
);

$originalName = 'example.png';

$imagedata = file_get_contents($originalName);
$imagebase64 = base64_encode($imagedata);

$params = array(
   'method' => 'add', /* новое объявление */                              
   'params' => array( 
        'country' => 46, /* Россия */
        'city' => 11494, /* Москва */
        'section' => 'auto', /* Транспорт */
        'category' => 24, /* Легковые автомобили */
        'days' => 30, /* срок размещения дней */           
        'type' => 1, /* Продам */                     
        'contact' => 'Светлана', /* Контактное лицо */
        'telephone' => '(499) 123-13-13', 
        'title' => 'Porsche Panamera', /* заголовок */
        'description' => '...', /* текст объявления */
        'pricetype' => 1, /* Фиксированная */
        'price' => 2390000, /* цена */
        'currency' => 35, /* Российский рубль */
        'images' => array( /* Optional */
             array(
                'imageData' => $imagebase64, // base64Binary
                'originalName' => $originalName                             
             )                        
        )       
   ),
   'autoOptions' => array( /* Дополнительные параметры */
       'brand' => 162, /* Porsche */
       'model' => 2584, /* Panamera */
       'year' => 2017, /* год выпуска */
       'mileage' => 10000.00, /*пробег */
       'body' => 2, /* Хэтчбек */
       'customs' => 1, /* Растаможен */
       'state' => 0, /* С пробегом */
       'color' => 2, /* черный */
       'motor' => 1, /* Бензин */
       'rudder' => 1, /* Левый руль */
       'transmission' => 2 /* Автомат */
   )
);
$body = json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
$streamOptions = stream_context_create(array(
   'http' => array(
      'method' => 'POST',
      'header' => $headers,
      'content' => $body
   )
));
$result = file_get_contents($url, 0, $streamOptions);

echo $result;
?>

Добавление объявления в раздел "Товары"