API Authorization: различия между версиями
User (обсуждение | вклад) |
User (обсуждение | вклад) |
||
| Строка 2: | Строка 2: | ||
==Обзор== | ==Обзор== | ||
| − | Данный документа описывает | + | ''Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.'' |
| + | |||
| + | Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://smartsatu.com/api/user/login. Headers в данном запросе не обрабатываются и могут быть пустыми. Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu. | ||
'''Версия''' | '''Версия''' | ||
| Строка 56: | Строка 58: | ||
==Определения== | ==Определения== | ||
===Login=== | ===Login=== | ||
| + | Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. | ||
{| class="wikitable" | {| class="wikitable" | ||
! style="font-weight:bold;" | Name | ! style="font-weight:bold;" | Name | ||
| Строка 81: | Строка 84: | ||
===Login Response=== | ===Login Response=== | ||
| − | + | В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token". | |
{| class="wikitable" | {| class="wikitable" | ||
! style="font-weight:bold;" | Name | ! style="font-weight:bold;" | Name | ||
| Строка 201: | Строка 204: | ||
| URL | | URL | ||
| string | | string | ||
| − | | https://food.smartsatu. | + | | https://food.smartsatu.com/api |
|} | |} | ||
| Строка 230: | Строка 233: | ||
"country": "kz", | "country": "kz", | ||
"direction": "Food", | "direction": "Food", | ||
| − | "url_api": "https://food.smartsatu. | + | "url_api": "https://food.smartsatu.com/api" |
} | } | ||
Версия 05:34, 13 января 2020
API Авторизации
Содержание
Обзор
Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.
Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://smartsatu.com/api/user/login. Headers в данном запросе не обрабатываются и могут быть пустыми. Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.
Версия
Version: 1.0.0
Контактная информация
Contact: info@smartsatu.com
URI схема
Host : //smartsatu.com/api/user/ Schemes : HTTPS
Методы
Авторизация пользователя
POST /login
Описание
Метод для авторизации пользователя в системе Smart Satu
Параметры
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | Авторизация пользователя | Login |
Ответы
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Ok | Login Response |
Принимаемые ресурсом типы MIME
- application/json
Возвращаемые ресурсом типы MIME
- application/json
Определения
Login
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
| Name | Description | Schema | Example |
|---|---|---|---|
| login | Логин | string | supplier |
| password | Пароль | string | qwerty |
Пример запроса:
{
"username" : "supplier",
"password" : "qwerty"
}
Login Response
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
| Name | Description | Schema | Example |
|---|---|---|---|
| id | Уникальный идентификатор | string | 132 |
| Почта | string | daulet@smartsatu.kz | |
| phone | Номер телефона | string | null |
| username | Логин | string | supplier |
| first_name | Имя | string | Иван |
| last_name | Фамилия | string | Иванов |
| middle_name | Отчество | string | Иванович |
| access_token | Уникальный токен для входа | string | bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd |
| role | Роль | string | 2 |
| city_id | Город | string | 1 |
| is_document | Лицензия | boolean | true |
| is_replacement | Доступность обмена | boolean | false |
| currency | Валюта | string | тг |
| price_decimals | Количество нолей после разделителя | string | 0 |
| price_radix | Разделитель разрядов | string | |
| price_decimals_separator | Разделитель | string | . |
| price_before_currency | Порядок показа валюты/цены | boolean | true |
| price_pattern | Паттерн цены | string | ### ### тг |
| cashback_enabled | Доступность кэшбэка | boolean | true |
| company_id | Идентификатор компании | string | 84 |
| country | Страна | string | kz |
| direction | Стейджинг | string | Food |
| url_api | URL | string | https://food.smartsatu.com/api |
Пример ответа:
{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 0,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ### тг",
"cashback_enabled": true,
"company_id": 84,
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.com/api"
}
