Инструменты пользователя
api:general
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
api:general [2014/07/22 12:08] andrew |
api:general [2014/07/22 12:27] (текущий) andrew |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | Servitum API v1.0 | + | ====== Servitum API v1.0 ====== |
| - | ================= | + | |
| - | Базовые правила | + | |
| - | --------------- | + | ===== Базовые правила ===== |
| **API** (англ. Application Program Interface) – это интерфейс программирования, который позволяет сайту клуба взаимодействовать с сервером и получать доступ к функционалу сервиса управления фитнес клубом. | **API** (англ. Application Program Interface) – это интерфейс программирования, который позволяет сайту клуба взаимодействовать с сервером и получать доступ к функционалу сервиса управления фитнес клубом. | ||
| Строка 12: | Строка 11: | ||
| - | Общий формат запроса | + | ===== Общий формат запроса ===== |
| - | -------------------- | + | |
| - | https://app.servitum.net/api?api_key=<апи ключ компании>&format=<json|xml>&request=<имя операции>&<дополнительные параметры спецефические для запроса> | ||
| - | Где: | + | https://app.servitum.net/api?api_key=<апи ключ компании>&format=<json|xml>&request=<имя операции>&<дополнительные параметры спецефические для запроса> |
| - | * api_key - API Key компании | + | Список параметров: |
| - | * format - формат возвращаемых данных (необязательный параметр, может быть опущен; по умолчанию json) | + | |
| - | * request - команда запроса (на данный момент есть только одна команда - customer_memberships) | + | |
| - | * дополнительные параметры - параметры, специфичные для каждой команды | + | |
| + | * ''api_key'' - API Key компании | ||
| + | * ''format'' - формат возвращаемых данных (необязательный параметр, может быть опущен; по умолчанию json) | ||
| + | * ''request'' - команда запроса (на данный момент есть только одна команда - customer_memberships) | ||
| + | * ''дополнительные параметры'' - параметры, специфичные для каждой команды | ||
| - | Получение активных абонементов клиента | ||
| - | Имя команды - customer_memberships | + | ===== Получение активных абонементов клиента ===== |
| + | |||
| + | Имя команды - **customer_memberships** | ||
| Эта команда возвращает список активных абонементов указанного клиента. | Эта команда возвращает список активных абонементов указанного клиента. | ||
| Список параметров специфических для этой команды: | Список параметров специфических для этой команды: | ||
| - | * last_name - фамилия клиента. Параметр не чувтсвителен к регистру букв | + | |
| - | * phone - телефон клиента в том формате, в котором он хранится в базе (включая ведущий знак +) | + | * ''last_name'' - фамилия клиента. Параметр не чувтсвителен к регистру букв |
| + | * ''phone'' - телефон клиента в том формате, в котором он хранится в базе (включая ведущий знак +) | ||
| Команда ищет клиента по полному совпадению фамилии и номера телефона одновременно. Т.е. если указать только фамилию без телефона, то команда выведет, что клиент не найден. | Команда ищет клиента по полному совпадению фамилии и номера телефона одновременно. Т.е. если указать только фамилию без телефона, то команда выведет, что клиент не найден. | ||
| Строка 41: | Строка 41: | ||
| Пример запроса: | Пример запроса: | ||
| - | https://app.servitum.net/api?api_key=5ca5b3ff853afb7022a90c9ecaf19490&format=json&request=customer_memberships&last_name=Агипов&phone=%2B380663332211 | + | https://app.servitum.net/api?api_key=5ca5b3ff853afb7022a90c9ecaf19490&format=json&request=customer_memberships&last_name=Агипов&phone=%2B380663332211 |
| - | здесь %2B380663332211 -- номер телефона +380663332211, где знак + заменен на URL Encoded представление %2B | + | здесь ''%2B380663332211'' -- номер телефона +380663332211, где знак + заменен на URL Encoded представление %2B |
| Привер ответа: | Привер ответа: | ||
| - | {"success":true,"data":[{"name":"Трен Зал 1 мес","status":"active","start":"11.07.2014","end":"10.08.2014","freeze_days_left":"5","services":[{"service_name":"Тренажерный зал","service_left":"11","service_used":"1"}]}]} | + | |
| + | {"success":true, "data": [{"name":"Трен Зал 1 мес","status":"active", "start":"11.07.2014", | ||
| + | "end":"10.08.2014", "freeze_days_left":"5", | ||
| + | "services":[{"service_name":"Тренажерный зал", "service_left":"11","service_used":"1"}]}]} | ||
| здесь | здесь | ||
| - | success - статус обработки команды | + | |
| - | data - список активных абонементов клиента | + | * ''success'' - статус обработки команды |
| - | { | + | * ''data'' - список активных абонементов клиента |
| + | |||
| + | { | ||
| "name":"Трен Зал 1 мес" - название абонемента | "name":"Трен Зал 1 мес" - название абонемента | ||
| "status":"active" - статус абонемента | "status":"active" - статус абонемента | ||
| Строка 65: | Строка 71: | ||
| "service_used":"1" - количество использованных занятий | "service_used":"1" - количество использованных занятий | ||
| }] | }] | ||
| - | } | + | } |
| Текст возвращается в кодировке utf-8. | Текст возвращается в кодировке utf-8. | ||
| - | В случае ошибки команда выдает статус "false" и в поле "error" выводится текст сообщения об ошибке. Например: | + | В случае ошибки команда выдает статус ''false'' и в поле ''error'' выводится текст сообщения об ошибке. |
| - | {"success":false,"error":"Customer not found"} | + | Например: |
| + | |||
| + | ''{"success":false, "error":"Customer not found"}'' | ||
api/general.1406030909.txt.gz · Последние изменения: 2014/07/22 12:08 — andrew
Инструменты страницы
Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
