API Authorization: различия между версиями

Материал из SmartSatu Knowledge Base
Перейти к навигации Перейти к поиску
Строка 58: Строка 58:
 
===Login===
 
===Login===
  
−
{
+
Пример запроса:
−
   "items": [
+
{
−
    {
+
   "username" : "supplier",
−
      "id": 203181,
+
  "password" : "qwerty"
−
      "store_user_id": 656,
+
}
−
      "store_company_id": 80,
+
 
−
      "delivery_date": 1537509600,
+
 
−
      "initial_delivery_date": null,
+
===Login Response===
−
      "supplier_company_id": 84,
+
−
      "supplierCompanyName": "ТОО \"Поставщиk-\"",
+
{| class="wikitable"
−
      "status": 7,
+
! style="font-weight:bold;" | Name
−
      "created_at": 1528706885,
+
! style="font-weight:bold;" | Description
−
      "updated_at": 1577099908,
+
! style="font-weight:bold;" | Schema
−
      "with_documents": 1,
+
! style="font-weight:bold;" | Example
−
      "sum": 0,
+
|-
−
      "comments": [
+
| style="font-weight:bold;" | id
−
        {
+
| Уникальный идентификатор
−
          "id": 75668,
+
| string
−
          "company_id": 84,
+
| 132
−
          "message": "Товарные позиции заказа были изменены.",
+
|-
−
          "type": 4,
+
| style="font-weight:bold;" | email
−
          "order_id": 203181,
+
| Почта
−
          "created_at": 1537426304,
+
| string
−
          "companyName": "Системное сообщение",
+
| daulet@smartsatu.kz
−
          "is_system": 1
+
|-
−
        }
+
| style="font-weight:bold;" | phone
−
      ],
+
| Номер телефона
−
      "replacement_id": null,
+
| string
−
      "replacement_status": null,
+
| null
−
      "alcohol_license": {
+
|-
−
        "number": "1234",
+
| style="font-weight:bold;" | username
−
        "expire_at": 1590883200,
+
| Логин
−
        "expire_at_date": "31.05.2020"
+
| string
−
      },
+
| supplier
−
      "payment_type": 0,
+
|-
−
      "order_items": [],
+
| style="font-weight:bold;" | first_name
−
      "supplier_company_name": "ТОО \"Поставщиk-\"",
+
| Имя
−
      "store_company": {
+
| string
−
        "route_list": {
+
| Иван
−
          "start_time": "11:15",
+
|-
−
          "end_time": "23:15"
+
| style="font-weight:bold;" | last_name
−
        },
+
| Фамилия
−
        "id": 80,
+
| string
−
        "name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
+
| Иванов
−
        "min_order_price": 0,
+
|-
−
        "email": "shop@me.kz",
+
| style="font-weight:bold;" | middle_name
−
        "description": "Магазин для тестирования\r\n",
+
| Отчество
−
        "contact": "Телефон: +77775554433, Вн.: 123, Контактное лицо: Гайка",
+
| string
−
        "address": "г. Алматы, ул. Стальского д. 31/1",
+
| Иванович
−
        "type": 1,
+
|-
−
        "tin": "012345678912",
+
| style="font-weight:bold;" | access_token
−
        "phone": "+77775554433",
+
| Уникальный токен для входа
−
        "supplier_rule": null,
+
| string
−
        "logo": "http://food.smartsatu.xyz/images/no_image_130x130.png",
+
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
−
        "has_replacement_products": null,
+
|-
−
        "cashback_percent": true,
+
| style="font-weight:bold;" | role
−
        "has_cashback": false,
+
| Роль
−
        "position": 999,
+
| string
−
        "supplier_store_id": "000000000"
+
| 2
−
      }
+
|-
−
    }
+
| style="font-weight:bold;" | city_id
 +
| Город
 +
| string
 +
| 1
 +
|-
 +
| style="font-weight:bold;" | is_document
 +
| Лицензия
 +
| boolean
 +
| true
 +
|-
 +
| style="font-weight:bold;" | is_replacement
 +
| Доступность обмена
 +
| boolean
 +
| false
 +
|-
 +
| style="font-weight:bold;" | currency
 +
| Валюта
 +
| string
 +
| тг
 +
|-
 +
| style="font-weight:bold;" | price_decimals
 +
| Количество нолей после разделителя
 +
| string
 +
| 0
 +
|-
 +
| style="font-weight:bold;" | price_radix
 +
| Разделитель разрядов
 +
| string
 +
|
 +
|-
 +
| style="font-weight:bold;" | price_decimals_separator
 +
| Разделитель
 +
| string
 +
| .
 +
|-
 +
| style="font-weight:bold;" | price_before_currency
 +
| Порядок показа валюты/цены
 +
| boolean
 +
| true
 +
|-
 +
| style="font-weight:bold;" | price_pattern
 +
| Паттерн цены
 +
| string
 +
| ### ### тг
 +
|-
 +
| style="font-weight:bold;" | cashback_enabled
 +
| Доступность кэшбэка
 +
| boolean
 +
| true
 +
|-
 +
| style="font-weight:bold;" | company_id
 +
| Идентификатор компании
 +
| string
 +
| 84
 +
|-
 +
| style="font-weight:bold;" | country
 +
| Страна
 +
| string
 +
| kz
 +
|-
 +
| style="font-weight:bold;" | direction
 +
| Стейджинг
 +
| string
 +
| Food
 +
|-
 +
| style="font-weight:bold;" | url_api
 +
| URL
 +
| string
 +
| https://food.smartsatu.xyz/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.xyz/api"
 +
}

Версия 03:37, 9 января 2020

API Авторизации

Обзор Данный документа описывает методы для работы поставщика/дистрибьютора с системой 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 Авторизация пользователя TEst

Ответы

HTTP Code Description Schema
200 Ok TEst

Принимаемые ресурсом типы MIME

  • application/json

Возвращаемые ресурсом типы MIME

  • application/json

Определения

Login

Пример запроса: 

{
 "username" : "supplier",
 "password" : "qwerty"
}


Login Response

Name Description Schema Example
id Уникальный идентификатор string 132
email Почта 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.xyz/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.xyz/api"
}
Источник — https://docs.smartsatu.com/wiki/index.php?title=API_Authorization&oldid=573