Общая информация » История » Версия 9
Артем, 16.10.2016 10:58
| 1 | 1 | Артем | h1. Общая информация |
|---|---|---|---|
| 2 | |||
| 3 | 2 | Артем | h1. Вызов методов API |
| 4 | 1 | Артем | |
| 5 | 2 | Артем | |
| 6 | Вызов метода осуществляется посредством подачи GET запроса на адрес http://api.ilcats.ru/ |
||
| 7 | |||
| 8 | Обязательные параметры при вызове каждого из методов: |
||
| 9 | 1 | Артем | |=.Параметр|=.Описание| |
| 10 | |=.*apiKey*|API-ключ| |
||
| 11 | |=.*clientId*|Ваш ID клиента| |
||
| 12 | |=.*domain*|Домен, для которого сгенерирован API-ключ| |
||
| 13 | 6 | Артем | |=.*function*|Название вызываемого метода| |
| 14 | 9 | Артем | |=.*apiVersion*|Версия вызываемого метода API| |
| 15 | 1 | Артем | |
| 16 | 2 | Артем | |
| 17 | 9 | Артем | Пример вызова: http://api.ilcats.ru/?clientId=102934&domain=www.neoriginal.ru&apiKey=aaabbbcccdddeeegggfkkk&function=getModels&version=1.0 |
| 18 | 1 | Артем | |
| 19 | 2 | Артем | |
| 20 | |||
| 21 | 1 | Артем | Данные возвращаются в формате json. |
| 22 | 2 | Артем | |
| 23 | h1. Общие методы |
||
| 24 | |||
| 25 | |||
| 26 | h2. getImageHash |
||
| 27 | |||
| 28 | h3. Описание метода |
||
| 29 | |||
| 30 | --- |
||
| 31 | |||
| 32 | p(. Возвращает хеш-ключ для указанного файла с изображением. |
||
| 33 | |||
| 34 | h3. Параметры вызова |
||
| 35 | |||
| 36 | --- |
||
| 37 | |||
| 38 | |=.Параметр|Обязательный|=.Описание| |
||
| 39 | |=.*function*|=.+|getImageHash| |
||
| 40 | |=.*apiKey*|=.+|API-ключ| |
||
| 41 | 3 | Артем | |=.*clientId*|=.+|Ваш ID клиента| |
| 42 | |=.*domain*|=.+|Домен, для которого сгенерирован API-ключ| |
||
| 43 | |=.*brand*|=.+|Бренд каталога| |
||
| 44 | |=.*filename*|=.+|Имя файла| |
||
| 45 | |=.*scale*|=.+|Масштаб| |
||
| 46 | 2 | Артем | |
| 47 | h3. Возвращаемые данные |
||
| 48 | |||
| 49 | --- |
||
| 50 | |||
| 51 | p(. Метод возвращает структуру *imageHash* |
||
| 52 | |||
| 53 | |||
| 54 | |=.Название|=.Описание| |
||
| 55 | |=.*hash*|Хеш для открытия файла| |
||
| 56 | |=.*domain*|Домен, для которого сгенерирован API-ключ| |
||
| 57 | |=.*filename*|Имя файла| |
||
| 58 | |=.*scale*|Масштаб| |
||
| 59 | |||
| 60 | --- |
||
| 61 | 6 | Артем | |
| 62 | h2. getImageScales |
||
| 63 | |||
| 64 | h3. Описание метода |
||
| 65 | |||
| 66 | --- |
||
| 67 | |||
| 68 | p(. Возвращает список доступных масштабов изображений для выбранного каталога/бренда. |
||
| 69 | |||
| 70 | h3. Параметры вызова |
||
| 71 | |||
| 72 | --- |
||
| 73 | |||
| 74 | |=.Параметр|ОбязательныйgetImageHashОписание| |
||
| 75 | |=.*function*|=.+|getImageHash| |
||
| 76 | |=.*apiKey*|=.+|API-ключ| |
||
| 77 | |=.*clientId*|=.+|Ваш ID клиента| |
||
| 78 | |=.*domain*|=.+|Домен, для которого сгенерирован API-ключ| |
||
| 79 | |=.*brand*|=.+|Бренд каталога| |
||
| 80 | |||
| 81 | |||
| 82 | h3. Возвращаемые данные |
||
| 83 | |||
| 84 | --- |
||
| 85 | |||
| 86 | p(. Метод возвращает структуру *imageHash* |
||
| 87 | |||
| 88 | |||
| 89 | |=.Название|=.Описание| |
||
| 90 | 8 | Артем | |=.*imageScales*|Список доступных масштабов изображений для каталога| |
| 91 | 6 | Артем | |
| 92 | --- |
||
| 93 | |||
| 94 | 2 | Артем | |
| 95 | h3. Использование изображений на своем сайте |
||
| 96 | |||
| 97 | 7 | Артем | p(. Для вывода изображений на своем сайте используйте ссылку вида http://images.neoriginal.ru/getImage.php?catalog=audi&filename=118/118201050.png&scale=75&hash=59cf407798cf1a0dba0a74704512f112&domain=www.ilcats.ru |
| 98 | 4 | Артем | |
| 99 | 5 | Артем | _*Примечание*_ |
| 100 | |||
| 101 | p(. _Вы можете использовать свой домен вроде http://images.YourDomain.com . Для этого достаточно на Ваших DNS серверах прописать запись вида images CNAME images.neoriginal.ru_ |