Проект

Общее

Профиль

Общая информация » История » Редакция 10

Редакция 9 (Артем, 16.10.2016 10:58) → Редакция 10/26 (Артем, 22.05.2017 16:05)

h1. Общая информация 

 h1. Вызов методов API 


 Вызов метода осуществляется посредством подачи GET запроса на адрес http://api.ilcats.ru/  

 Обязательные параметры при вызове каждого из методов: 
 |=.Параметр|=.Описание| 
 |=.*apiKey*|API-ключ| 
 |=.*clientId*|Ваш ID клиента| 
 |=.*domain*|Домен, для которого сгенерирован API-ключ| 
 |=.*function*|Название вызываемого метода| 
 |=.*apiVersion*|Версия вызываемого метода API| 


 Пример вызова: http://api.ilcats.ru/?clientId=102934&domain=www.neoriginal.ru&apiKey=aaabbbcccdddeeegggfkkk&function=getModels&version=1.0 



 Данные возвращаются в формате json. 

 h1. Общие методы 


 h2. getImageHash  

 h3. Описание метода 

 --- 

 p(. Возвращает хеш-ключ для указанного файла с изображением. 

 h3. Параметры вызова 

 --- 

 |=.Параметр|Обязательный|=.Описание| 
 |=.*function*|=.+|getImageHash| 
 |=.*apiKey*|=.+|API-ключ| 
 |=.*clientId*|=.+|Ваш ID клиента| 
 |=.*domain*|=.+|Домен, для которого сгенерирован API-ключ| 
 |=.*brand*|=.+|Бренд каталога| 
 |=.*filename*|=.+|Имя файла| 
 |=.*scale*|=.+|Масштаб| 

 h3. Возвращаемые данные 

 --- 

 p(. Метод возвращает структуру *imageHash* 


 |=.Название|=.Описание| 
 |=.*hash*|Хеш для открытия файла| 
 |=.*domain*|Домен, для которого сгенерирован API-ключ| 
 |=.*filename*|Имя файла| 
 |=.*scale*|Масштаб| 

 --- 

 h2. getImageScales  

 h3. Описание метода 

 --- 

 p(. Возвращает список доступных масштабов изображений для выбранного каталога/бренда. 

 h3. Параметры вызова 

 --- 

 |=.Параметр|ОбязательныйgetImageHashОписание| 
 |=.*function*|=.+|getImageHash| 
 |=.*apiKey*|=.+|API-ключ| 
 |=.*clientId*|=.+|Ваш ID клиента| 
 |=.*domain*|=.+|Домен, для которого сгенерирован API-ключ| 
 |=.*brand*|=.+|Бренд каталога| 


 h3. Возвращаемые данные 

 --- 

 p(. Метод возвращает структуру *imageHash* 


 |=.Название|=.Описание| 
 |=.*imageScales*|Список доступных масштабов изображений для каталога| 

 --- 


 h3. Использование изображений на своем сайте 

 p(. Для вывода изображений на своем сайте используйте ссылку вида http://images.neoriginal.ru/getImage.php?catalog=audi&filename=118/118201050.png&scale=75&hash=59cf407798cf1a0dba0a74704512f112&domain=www.ilcats.ru 

 _*Примечание*_ 

 p(. _Вы можете использовать свой домен вроде http://images.YourDomain.com . Для этого достаточно на Ваших DNS серверах прописать запись вида     images CNAME images.neoriginal.ru_