Swagger API Личный кабинет Центр поддержки

Получение схемы подключения СД #

Адрес метода #

DELETE /connections/schemas

Предназначение #

Возвращает набор полей каждой службы доставки, которые возможно заполнить для создания\обновления подключения (connectParams)

Метод возвращает схему подключения к службе доставки. Обычно используется для отрисовки формы создания подключения на стороне маркетплейса\модуля\аггрегатора. Т.е. метод необходим если вам нужно дать возможность своим пользователям создавать подлючения, иначе лучше это делать через наш личный кабинет.

Массив fields - это список полей connectParams в методе createConnection

  • code - это название поля в json
  • type - это тип значения
  • values - это массив с возможными значениями для поля.
  • multiple - поле может принимать несколько значений, т.е. значение поля является массивом.
  • required - поле обязательно для передачи

Сценарий:

  1. Получаете схемы всех служб.
  2. По схеме отрисовываете форму для нужной службы доставки.
  3. Формируете connectParams собранный из этой формы.
  4. Создаете подключение.

Пример:

  1. Получили схему Деливери.Клаб
{
   "providerKey": "d-club",
   "fields": [
     {
       "code": "login",
       "name": "Логин",
       "description": "Логин",
       "type": "string",
       "required": true,
       "multiple": false,
       "values": []
     },
     {
       "code": "password",
       "name": "Пароль",
       "description": "Пароль",
       "type": "string",
       "required": true,
       "multiple": false,
       "values": []
     }
   ]
 }
  1. Создаем подключение на основе схемы. Схема это набор полей в параметре connectParams:
"connectParams": {
  "login": "mylogin",
  "password": "mypassword"
}
  1. В итоге получаем такую структуру для создания подключения:
{
  "name": "Основное подключение к службе доставки",
  "providerKey": "d-club",
  "insuranceRate": 0,
  "cashServiceRate": 0,
  "connectParams": {
    "login": "mylogin",
    "password": "mypassword"
  },
  "isUseBaseConnect": 0
}

Параметры запроса #

ПараметрТип данныхОписаниеОбязательностьПример
limitЧислоЛимит по выводу (Minimum - 0, Maximum - 5000)да23
offsetЧислоВыбора с какого эл-та начинать вывод (Minimum - 1, Maximum - 100)да10
filterСтрокаФильтрации схемы по службе доставкидаcdek

Пример данных запроса #

1
2
3
4
5
{
    "limit": "23",
    "offset": "10",
    "filter": "cdek"
}
1
2
3
4
5
6
<?xml version="1.0" encoding="UTF-8"?>
<request>
   <filter>cdek</filter>
   <limit>23</limit>
   <offset>10</offset>
</request>

Параметры ответа #

ПараметрОписаниеТипПример
providerKeyКод службы доставкиСтрокаcdek
fieldsПоля для подключенияМассив строк

Содержание fields (Поля для подключения):

ПараметрОписаниеТипПример
codeКод поляСтрокаlogin
nameТекстовое название переменнойСтрокаЛогин
descriptionТекстовое описаниеЛогин в системе службы доставки
typeТип, который принимает полеСтрокаfloat
requiredОбязательно ли полеБулев1
multipleМожет ли поле принимать несколько значенийБулев1
valuesОбъект с возможными значениями для поля. Если у поля type=array и multiple=false, то передавать значение не оборачивая в массив

Пример данных ответа #

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
  "rows": [
    {
      "providerKey": "cdek",
      "fields": [
        {
          "code": "account",
          "name": "Account/Идентификатор",
          "description": "Значение можно получить в ЛК СДЕК, раздел интеграция",
          "type": "string",
          "required": true,
          "multiple": false,
          "values": []
        },
        {
          "code": "password",
          "name": "Secure password/Пароль",
          "description": "Значение можно получить в ЛК СДЕК, раздел интеграция",
          "type": "string",
          "required": true,
          "multiple": false,
          "values": []
        },
        {
          "code": "labelSize",
          "name": "Печать ШК-места",
          "description": "Размер печатной формы этикетки для упаковки в формате pdf",
          "type": "string",
          "required": false,
          "multiple": false,
          "values": [
            {
              "label": "Отключено",
              "value": "disable"
            },
            {
              "label": "A6",
              "value": "A6"
            },
            {
              "label": "A5",
              "value": "A5"
            },
            {
              "label": "A4",
              "value": "A4"
            }
          ]
        },
        {
          "code": "printCount",
          "name": "Печать квитанции к заказу",
          "description": "Рекомендовано указывать не менее 2, одна приклеивается на груз, вторая остается у отправителя",
          "type": "string",
          "required": false,
          "multiple": false,
          "values": [
            {
              "label": "Отключено",
              "value": "disable"
            },
            {
              "label": "2 копии",
              "value": "2"
            },
            {
              "label": "4 копии",
              "value": "4"
            }
          ]
        },
        {
          "code": "sendSender",
          "name": "Информация об отправителе",
          "description": "",
          "type": "string",
          "required": false,
          "multiple": false,
          "values": [
            {
              "label": "Из договора СДЭК",
              "value": "0"
            },
            {
              "label": "Из данных по API",
              "value": "1"
            }
          ]
        },
        {
          "code": "callCourier",
          "name": "Автоматически вызывать курьера",
          "description": "",
          "type": "bool",
          "required": false,
          "multiple": false,
          "values": []
        },
        {
          "code": "sendDeliveryAsItem",
          "name": "Передавать доставку как товар",
          "description": "",
          "type": "bool",
          "required": false,
          "multiple": false,
          "values": []
        },
        {
          "code": "notSendItemArticle",
          "name": "Не отправлять артикулы товаров при оформлении доставки",
          "description": "",
          "type": "bool",
          "required": false,
          "multiple": false,
          "values": []
        },
        {
          "code": "test",
          "name": "Тестовый режим",
          "description": "",
          "type": "bool",
          "required": false,
          "multiple": false,
          "values": []
        }
      ]
    }
  ],
  "meta": {
    "total": 1,
    "offset": 0,
    "limit": 10
  }
}
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <rows>
      <item>
        <providerKey>cdek</providerKey>
        <fields>
          <item>
            <code>account</code>
            <name>Account/Идентификатор</name>
            <description>Значение можно получить в ЛК СДЕК, раздел интеграция</description>
            <type>string</type>
            <required>true</required>
            <multiple>false</multiple>
            <values/>
          </item>
          <item>
            <code>password</code>
            <name>Secure password/Пароль</name>
            <description>Значение можно получить в ЛК СДЕК, раздел интеграция</description>
            <type>string</type>
            <required>true</required>
            <multiple>false</multiple>
            <values/>
          </item>
          <item>
            <code>labelSize</code>
            <name>Печать ШК-места</name>
            <description>Размер печатной формы этикетки для упаковки в формате pdf</description>
            <type>string</type>
            <required>false</required>
            <multiple>false</multiple>
            <values>
              <item>
                <label>Отключено</label>
                <value>disable</value>
              </item>
              <item>
                <label>A6</label>
                <value>A6</value>
              </item>
              <item>
                <label>A5</label>
                <value>A5</value>
              </item>
              <item>
                <label>A4</label>
                <value>A4</value>
              </item>
            </values>
          </item>
          <item>
            <code>printCount</code>
            <name>Печать квитанции к заказу</name>
            <description>Рекомендовано указывать не менее 2, одна приклеивается на груз, вторая остается у отправителя</description>
            <type>string</type>
            <required>false</required>
            <multiple>false</multiple>
            <values>
              <item>
                <label>Отключено</label>
                <value>disable</value>
              </item>
              <item>
                <label>2 копии</label>
                <value>2</value>
              </item>
              <item>
                <label>4 копии</label>
                <value>4</value>
              </item>
            </values>
          </item>
          <item>
            <code>sendSender</code>
            <name>Информация об отправителе</name>
            <description>
            </description>
            <type>string</type>
            <required>false</required>
            <multiple>false</multiple>
            <values>
              <item>
                <label>Из договора СДЭК</label>
                <value>0</value>
              </item>
              <item>
                <label>Из данных по API</label>
                <value>1</value>
              </item>
            </values>
          </item>
          <item>
            <code>callCourier</code>
            <name>Автоматически вызывать курьера</name>
            <description>
            </description>
            <type>bool</type>
            <required>false</required>
            <multiple>false</multiple>
            <values/>
          </item>
          <item>
            <code>sendDeliveryAsItem</code>
            <name>Передавать доставку как товар</name>
            <description>
            </description>
            <type>bool</type>
            <required>false</required>
            <multiple>false</multiple>
            <values/>
          </item>
          <item>
            <code>notSendItemArticle</code>
            <name>Не отправлять артикулы товаров при оформлении доставки</name>
            <description>
            </description>
            <type>bool</type>
            <required>false</required>
            <multiple>false</multiple>
            <values/>
          </item>
          <item>
            <code>test</code>
            <name>Тестовый режим</name>
            <description>
            </description>
            <type>bool</type>
            <required>false</required>
            <multiple>false</multiple>
            <values/>
          </item>
        </fields>
      </item>
    </rows>
    <meta>
      <total>1</total>
      <offset>0</offset>
      <limit>10</limit>
    </meta>
  </response>