API Counterparties

Обзор

Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

Версия

Version: 1.0.0

Контактная информация

Contact: info@smartsatu.com

URI схема

Host : //food.smartsatu.com/api/counterparties/  Schemes : HTTPS

Методы

Получение списка торговых точек

GET /counterparties 

Описание

Для получения списка всех торговых точек из системы Smart Satu необходимо отправить GET-запрос: https://food.smartsatu.com/api/counterparties

Ответом от сервера будет являться массив данных со списком первых 20-ти контрагентов системы. Запрос остальных контрагентов следует выполнять с использованием параметра "page=xx", который вернет еще 20 контрагентов с указанной страницы: https://food.smartsatu.com/api/counterparties?page=2

Список может быть отфильтрован с использованием параметра "updated_from=Y-m-d\TH:i:s", который вернет созданные/измененные записи за период, указанный в "updated_from": https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04

Безопасность

В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.

Type	In	Name	Description
Authorization	header	required	Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
country	header	required	Параметр страны должен использоваться в каждом запросе в системе.

Параметры

Ответы

HTTP Code	Description	Schema
200	Ok	Response Counterparties
401	Unauthorized	401

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

• application/json

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

• application/json

Определения

Response Counterparties

200

Items

Name	Description	Schema	Example
id	Уникальный идентификатор	integer	80
name	Название торговой точки	string	маг. "Рокфор"
address	Адрес торговой точки	string	Алматы, Байзакова, 125/185
conacts	Массив	<contacts> array
type	Тип торговой точки	string	store
tin	ИНН торговой точки	string	AZ0123456789
ucs	Уникальный идентификатор ТТ у поставщика (пр. GUID)	string	AZ0123456789

Contacts

Name	Description	Schema	Example
phone	Номер телефона	string	78000000001
person	Персона (Контактное лицо)	string	Гайка
ext	Дополнительный номер	string	123
type	Тип контакта	string

Пример ответа:

{
  "Items": [
    {
      "id": 80,
      "name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
      "address": "Алматы, Байзакова, 125/185",
      "contacts": [
        {
          "phone": "78000000001",
          "person": "Гайка",
          "ext": "123",
          "type": " "
        }
      ],
      "type": "store",
      "tin": "AZ0123456789"
      "ucs": "AZ0123456789"
    }
  ]
}

401

Name	Description	Schema	Example
name	Название торговой точки	string	Unauthorized
message	Сообщение	string	Your request was made with invalid credentials
code	Код	integer	0
status	Статус	integer	401
type	Тип	string

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401,
  "type": "yii\\web\\UnauthorizedHttpException"
}