Персональные инструменты

Интернет-магазин SaaS - API

Материал из wiki.2fox.org

Перейти к: навигация, поиск

API — набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением или операционной системой для использования во внешних программных продуктах.

Запросы к API

Для того чтобы вызвать метод API, Вам необходимо осуществить GET запрос по протоколу HTTP на указанный URL:

   http://mysite.com/api.html?action={METHOD_NAME}&api_key={API_KEY}

Методы

Получение списка категорий

Для того чтобы вызвать метод API, Вам необходимо осуществить GET запрос по протоколу HTTP на указанный URL:

   http://mysite.com/api.html?action=GetCategories&api_key={API_KEY}

Данный метод вернет json объект. Вся информация о категориях продуктов помещена в переменную content


Получение списка товаров

Работа данного метода похожа на работу модуля товары Для того чтобы вызвать метод API, Вам необходимо осуществить GET запрос по протоколу HTTP на указанный URL:

   http://mysite.com/api.html?action=GetProducts&api_key={API_KEY}

Данный метод вернет json объект. Вся информация о категориях продуктов помещена в переменную content

В качестве дополнительных параметров может быть передана переменная args (предварительно кодирована, например в js это делается с помощью encodeURIComponent). Переменная передается по аналогии с модулем

   http://mysite.com/api.html?action=GetProducts&api_key={API_KEY}&args=num=15,category=3,category!=5,order=DESC,orderby=id