Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
api:test [2018/11/13 08:26] susanin |
api:test [2020/09/24 09:42] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Базовые настройки ====== | ||
| - | ===== База данных ===== | ||
| - | **config/db.php** | ||
| - | <file PHP config/db.php> | ||
| - | <?php | ||
| - | return [ | ||
| - | 'class' => 'yii\db\Connection', | ||
| - | 'dsn' => 'mysql:host=127.0.0.1;dbname=test', | ||
| - | 'username' => 'root', | ||
| - | 'password' => 'root', | ||
| - | 'charset' => 'utf8', | ||
| - | 'tablePrefix'=>'tst_', | ||
| - | ]; | ||
| - | </file> | ||
| - | |||
| - | ===== Первая установка ===== | ||
| - | ==== Обновление зависимостей ==== | ||
| - | Для обновления зависимостей необходимо использовать composer https://getcomposer.org/ | ||
| - | php composer.phar update | ||
| - | |||
| - | ==== Установка миграций ==== | ||
| - | ./yii migrate/up | ||
| - | |||
| - | После установки миграций будет установлен пользователь **admin:admin** | ||
| - | |||
| - | ===== Apache/Nginx ===== | ||
| - | Необходимо настроить файлы правил переадресации запросов на файл index.php | ||
| - | |||
| - | |||
| ====== API ====== | ====== API ====== | ||
| Отправляемые данные могут быть как в **XML** так и в **JSON**. Адреса запросов можно переопределить в настройках приложения: **config/web**: | Отправляемые данные могут быть как в **XML** так и в **JSON**. Адреса запросов можно переопределить в настройках приложения: **config/web**: | ||
| Строка 205: | Строка 176: | ||
| <code> | <code> | ||
| "3", | "3", | ||
| - | <code> | + | </code> |
| - | ##SERVICE-RESIDENCE Услуга проживание | + | ===== SERVICE-RESIDENCE Услуга проживание ===== |
| ==== index ==== | ==== index ==== | ||
| Адрес: ''/api/service-residence/index?request=1'' <br> | Адрес: ''/api/service-residence/index?request=1'' <br> | ||
| Строка 381: | Строка 352: | ||
| <code> | <code> | ||
| 1 | 1 | ||
| - | <code> | + | </code> |
| - | ##SERVICE-TRANSFER Услуга трансфер | + | ===== SERVICE-TRANSFER Услуга трансфер ===== |
| ==== index ==== | ==== index ==== | ||
| Адрес: ''/api/service-transfer/index?request=1'' <br> | Адрес: ''/api/service-transfer/index?request=1'' <br> | ||
| Строка 549: | Строка 520: | ||
| <code> | <code> | ||
| 1 | 1 | ||
| - | <code> | + | </code> |
| - | ##SERVICE Услуга (остальные) | + | ===== SERVICE Услуга (остальные) ===== |
| ==== index ==== | ==== index ==== | ||
| Адрес: ''/api/service/index?request=1'', ''/api/service/index?request=1&service_type=2'' если нужна выборка по типу услуги | Адрес: ''/api/service/index?request=1'', ''/api/service/index?request=1&service_type=2'' если нужна выборка по типу услуги | ||
| Строка 705: | Строка 676: | ||
| <code> | <code> | ||
| 1 | 1 | ||
| - | <code> | + | </code> |
| - | ## SERVICE-RESIDENCE-GUEST Гости услуги проживание | + | ===== SERVICE-RESIDENCE-GUEST Гости услуги проживание ===== |
| ==== index ==== | ==== index ==== | ||
| Адрес: ''/api/service-residence-guest/index?service=1'' | Адрес: ''/api/service-residence-guest/index?service=1'' | ||
| Строка 802: | Строка 773: | ||
| <code> | <code> | ||
| 1 | 1 | ||
| - | <code> | + | </code> |
| ===== DOCUMENTS Документы | ===== DOCUMENTS Документы | ||
| Строка 935: | Строка 906: | ||
| <code> | <code> | ||
| 27 | 27 | ||
| - | <code> | + | </code> |
| ===== NOTIFICATION Уведомления ===== | ===== NOTIFICATION Уведомления ===== | ||
| Строка 1126: | Строка 1097: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |
| ===== COMPANY Компании | ===== COMPANY Компании | ||
| Строка 1284: | Строка 1255: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |
| - | ### ''delete-file'' удаление ORM данных | + | ==== delete-file удаление ORM данных ==== |
| Адрес: ''/api/company/delete-file?id=2&field=logo'' <br> | Адрес: ''/api/company/delete-file?id=2&field=logo'' <br> | ||
| Метод запрос: ''POST''<br> | Метод запрос: ''POST''<br> | ||
| Строка 1306: | Строка 1277: | ||
| <code> | <code> | ||
| - | ===== HOTEL Гостиницы | + | ===== HOTEL Гостиницы ===== |
| - | ===== | + | |
| ==== index ==== | ==== index ==== | ||
| Адрес: ''/api/company/index'', ''/api/company/index?limit=20&offset=0'' с указанием количества отображаемый записей (limit) и сдвиг (offset) | Адрес: ''/api/company/index'', ''/api/company/index?limit=20&offset=0'' с указанием количества отображаемый записей (limit) и сдвиг (offset) | ||
| Строка 1562: | Строка 1532: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |
| - | ### ''delete-file'' удаление ORM поля | + | ==== ''delete-file'' удаление ORM поля ==== |
| Адрес: ''/api/hotel/delete-field?id=2&field=photo'' | Адрес: ''/api/hotel/delete-field?id=2&field=photo'' | ||
| Метод запрос: ''POST''<br> | Метод запрос: ''POST''<br> | ||
| Строка 1607: | Строка 1577: | ||
| <code> | <code> | ||
| - | ===== USER Пользователи | + | ===== USER Пользователи ===== |
| - | ===== | + | |
| ==== index ==== | ==== index ==== | ||
| Адрес: ''/api/user/index'', ''/api/user/index?type=susanin'' - пользователи компании, в противном случае список клиентов | Адрес: ''/api/user/index'', ''/api/user/index?type=susanin'' - пользователи компании, в противном случае список клиентов | ||
| Строка 1779: | Строка 1748: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |
| ===== CITY Города ===== | ===== CITY Города ===== | ||
| Строка 1869: | Строка 1838: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |
| - | ## HOTEL-ROOM Номера гостиниц | + | ===== HOTEL-ROOM Номера гостиниц ===== |
| ==== index ==== | ==== index ==== | ||
| Строка 1979: | Строка 1948: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |
| - | ## COMPANY-CONSIGNEE Грузополучатели | + | ===== COMPANY-CONSIGNEE Грузополучатели ===== |
| ==== index ==== | ==== index ==== | ||
| Строка 2069: | Строка 2038: | ||
| <code> | <code> | ||
| 2 | 2 | ||
| - | <code> | + | </code> |