API

Api Documentation
 1.0.0 
OAS3

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

Передача данных происходит в формате JSON. Принцип формирования url для запроса к АПИ.

{Protocol}://{URL}/{api_router}/{controller}/{function}&{Params}


GET

Token

ParamValue

Protocol      http

URL            projet.market

api_router   index.php?route=api

controller    login

function      index

Params      key="#api_key#"

  • api_key - предоставляется администратором ресурса 

Тело ответа :

В случае успеха

{"success":"API \u0441\u0435\u0441\u0441\u0438\u044f \u0443\u0441\u043f\u0435\u0448\u043d\u043e \u0437\u0430\u043f\u0443\u0449\u0435\u043d\u0430!","api_token":"#api_token_message#"}

  • api_token_message - Токен авторизации сессии 


В случае ошибки:

{"error":" #error_message#"}

  • error_message - Текст ошибки


POST

Stocks

ParamValue

Protocol      http

URL            projet.market

api_router   index.php?route=api

controller    zstock

function      updatequantity

Params      api_token="#api_token#"

  • api_token -  токен авторизации сессии

Тело запроса:

data={"products":[{"model":"#model#","quantity":"#quantity#"}]}

  • model - код элемента товара 
  • quantity - количество товара

Тело ответа :

В случае успеха

{"success":"#N#"}

  • N - количество обработанных элементов 
В случае ошибки:

{"error":" #error_message#"}

  • error_message - Текст ошибки