Интернет-магазин SaaS - API — различия между версиями
Материал из wiki.2fox.org
2fox (обсуждение | вклад) |
2fox (обсуждение | вклад) |
||
| Строка 2: | Строка 2: | ||
== Запросы к API == | == Запросы к API == | ||
| − | Для того чтобы вызвать метод API, Вам необходимо осуществить GET запрос по протоколу HTTP на указанный URL: | + | Для того чтобы вызвать метод API, Вам необходимо осуществить '''GET''' запрос по протоколу '''HTTP''' на указанный URL: |
<source lang="php"> | <source lang="php"> | ||
http://mysite.com/api.html?action={METHOD_NAME}&api_key={API_KEY} | http://mysite.com/api.html?action={METHOD_NAME}&api_key={API_KEY} | ||
| Строка 9: | Строка 9: | ||
== Методы == | == Методы == | ||
=== Получение списка категорий === | === Получение списка категорий === | ||
| − | Для того чтобы вызвать метод API, Вам необходимо осуществить GET запрос по протоколу HTTP на указанный URL: | + | Для того чтобы вызвать метод API, Вам необходимо осуществить '''GET''' запрос по протоколу '''HTTP''' на указанный URL: |
<source lang="php"> | <source lang="php"> | ||
http://mysite.com/api.html?action=GetCategories&api_key={API_KEY} | http://mysite.com/api.html?action=GetCategories&api_key={API_KEY} | ||
| Строка 19: | Строка 19: | ||
=== Получение списка товаров === | === Получение списка товаров === | ||
Работа данного метода похожа на работу модуля [[Обработчик шаблонов#.D0.A2.D0.BE.D0.B2.D0.B0.D1.80.D1.8B|товары]] | Работа данного метода похожа на работу модуля [[Обработчик шаблонов#.D0.A2.D0.BE.D0.B2.D0.B0.D1.80.D1.8B|товары]] | ||
| − | Для того чтобы вызвать метод API, Вам необходимо осуществить GET запрос по протоколу HTTP на указанный URL: | + | Для того чтобы вызвать метод API, Вам необходимо осуществить '''GET''' запрос по протоколу '''HTTP''' на указанный URL: |
<source lang="php"> | <source lang="php"> | ||
http://mysite.com/api.html?action=GetProducts&api_key={API_KEY} | http://mysite.com/api.html?action=GetProducts&api_key={API_KEY} | ||
| Строка 25: | Строка 25: | ||
Данный метод вернет '''json''' объект. Вся информация о категориях продуктов помещена в переменную content | Данный метод вернет '''json''' объект. Вся информация о категориях продуктов помещена в переменную content | ||
| − | В качестве дополнительных параметров может быть передана переменная args (предварительно кодирована, например в js это делается с помощью encodeURIComponent). Переменная передается по аналогии с модулем | + | В качестве дополнительных параметров может быть передана переменная '''args''' (предварительно кодирована, например в js это делается с помощью '''encodeURIComponent'''). Переменная передается по аналогии с модулем |
<source lang="php"> | <source lang="php"> | ||
http://mysite.com/api.html?action=GetProducts&api_key={API_KEY}&args=num=15,category=3,category!=5,order=DESC,orderby=id | http://mysite.com/api.html?action=GetProducts&api_key={API_KEY}&args=num=15,category=3,category!=5,order=DESC,orderby=id | ||
</source> | </source> | ||
Версия 16:25, 28 февраля 2016
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
