Работа с API веб-сайта poshk.ru

Система API позволяет внедрить информацию о наших продуктах ценах и т.д. практически в любой программный интерфейс. Система принимает GET запросы от клиентов, ограничений по количеству запросов нету. Возвращает система ответ в одном из двух выбранных форматах XML или JSON, по умолчанию выбран формат JSON если вы хотите его изменить добавьте в любой запрос параметр type. Результатом успешной или не успешной операции служит элемент status если запрос выполнился успешно, элемент status равен 0, если же произошла ошибка тогда 1.

Дополнительные параметры доступные в любом методе:

• Type (string) – указывает в каком формате вернуть ответ, доступные варианты xml или json

• Api_key (string) – неучитывается только в методе get-auth-token в остальных обязательное наличие

Методы интерфейса:

/api/get-auth-token?email={email}&password={password}

Метод с помощью которого вы можете получить так называемый api_key который не имеет ограничений по времени действия. Он необходим для последующих вызовов методов.

Параметры:

• Email (string) - email почта указанная при регистрации

• Password (string) – пароль от аккаунта

Пример:

http://poshk.ru/api/get-auth-token?email=test@mail.ru&password=123&type=xml

/api/my-info?api_key={api_key}

Метод возвращает информацию о владельце api_key ключа

Параметры:

• Api_key (string) – ключ полученный методом get-auth-token

Пример:

http://poshk.ru/api/my-info?api_key=12321

/api/get-agreements?api_key={api_key}

Метод возвращает все соглашения пользователя, соглашения пользователя с компанией регулируют цены на товар.

Параметры:

• Api_key (string) – ключ полученный методом get-auth-token

Пример:

http://poshk.ru/api/get-agreements?api_key={api_key}

/api/get-categories?api_key={api_key}

Метод возвращает категории товаров сайта poshk.ru.

Параметры:

• Api_key (string) – ключ полученный методом get-auth-token

Пример:

http://poshk.ru/api/get-categories ?api_key={api_key}

/api/get-item-from-category?api_key={api_key}&agreement_id={agreemenmt_id}&category_id={category_id}&page=1

Метод возвращает товары принадлежащие указанной категории category_id id которой можно получить воспользовавшись предыдущим методом. Параметр page является не обязательным указывает какую страницу с результатом показать по умолчанию первую страницу. Метод возвращает первые 25 найденных товаров из категории если нужно просмотреть оставшиеся увеличивайте параметр page на единицу. Цена для товара будет указана уже с учетом текущего выбранного соглашения пользователя на сайте.

Параметры

• Api_key (string) – ключ полученный методом get-auth-token

• Category_id (int) – id категории из которой нужно получить товары

• page(int) – номер страницы

• agreement_id (int)– id соглашения пользователя, узнать id соглашения можно воспользовавшись функцией /api/get-agreements?api_key={api_key}

 

/api/search-items?api_key={api_key}&agreement_id={agreemenmt_id}&category_id={category_id}&q={q}&page=1

Метод аналогичен предыдущему методу единственное отличие этот метод имеется обязательный параметр q, q это поисковое слово для выбранного каталога, по какому слову искать.

/api/get-remains-price?api_key={api_key}&agreement_id={agreemenmt_id}

Метод возвращает товары с характеристиками, остатками и ценами в соответствии с соглашением

Параметры

• Api_key (string) – ключ полученный методом get-auth-token

• agreement_id (int)– id соглашения пользователя, узнать id соглашения можно воспользовавшись функцией /api/get-agreements?api_key={api_key}

/api/get-products?api_key={api_key}&

Метод возвращает товары с характеристиками без цен

Параметры

Api_key (string) – ключ полученный методом get-auth-token

 

 

/api/get-contracts?api_key={api_key}

Метод возвращает договора партнера

Параметры

• Api_key (string) – ключ полученный методом get-auth-token

 

/api/get-counteragents?api_key={api_key}

Метод возвращает контрагентов партнера

Параметры

• Api_key (string) – ключ полученный методом get-auth-token

 

 

/api/get-order?api_key={api_key}&order_id={oder_id}

Метод возвращает данные о заказе партнера

Параметры

• Api_key (string) – ключ полученный методом get-auth-token

• order_id (string) – номер заказа

 

/api/create-order?api_key={api_key}

Метод создаёт заказ

Параметры

• api_key (string) – ключ полученный методом get-auth-token

• data(string) – данные о заказе в формате json

 

{"name":"Name","phone":"+79874563211","email":"test@test.ru","comment":"Comment","agreement_id":13189,"contract_id":12959,"counteragent_id":28781,"order_items":[{"product_id":3597,"count":10},{"product_id":10802,"count":20}]}

 

$data = array (

'name' => 'Name',

'phone' => '+79874563211',

'email' => 'test@test.ru',

'comment' => 'Comment',

'agreement_id' => 13189,

'contract_id' => 12959,

'counteragent_id' => 28781,

'order_items' =>

    array (

        0 =>

            array (

                'product_id' => 3597,

                'count' => 10,

            ),

        1 =>

            array (

                 'product_id' => 10802,

                 'count' => 20,

            ),

    ),

)