SelSup Developers

Интеграцияның негізгі қағидаттары · Кірістер

Басталу

Аутентификация, алғашқы сұрау, жергілікті қателер, бетін орналастыру және қауіпсіз өндіріс.

4 бөлімдеріДамушы нұсқаулығы

error-ті басқару және қайта сынақтан өткізуден кейін ғана мутациялар қосылады.

Багдейн әзірлеушілер мен интеграторлар

01

Аутентификация және белгілерді сақтау

API белгісін Authorization басымен Bearer префиксісіз тікелей жіберіңіз.

Әр интеграция үшін бөлек белгі құру. Содан кейін сіз басқаларды бұзбай, бір қосылымды қайтарып, оған қажетті рұқсаттарды ғана бере аласыз.

Сервер жағындағы құпияларға сақтаңыз. Оны ешқашан браузерге, JavaScript, мобильді қолданбаға, URL-ге, журналдарына немесе аналитикалық жүйелерге жібермеңіз.

!
Бұл OAuth емес

Bearer немесе Basic қосылмаңыз. Authorization мәні SelSup белгісі.

Бірінші өтініш · cURL
curl --request GET 'https://api.selsup.ru/api/brand/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

02

Қателер және хабарламаның жергілікті жері

error тұрақты өрісіне ауыстырыңыз және тек адам оқитын шығыс үшін localMessage-ды қолданыңыз.

error қосымшасы әдетте error, localMessage және params-ті қамтиды. Сервер localMessage-ді токенге ие пайдаланушының lang өрісін пайдалана отырып аударады.

Құжаттама тілі мен Accept-Language error локалын өзгертпейді. localMessage кодты ешқашан салыстыруға немесе машина мәртебесі ретінде сақтауға болмайды.

i
Диагностикалық контекст

HTTP, error, params, сұрау салу уақыты мен байланыстың ID-ін тіркеңіз.

Өтініш error келісімшарты · JSON
{
  "error": "brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

03

Үлкен жинақтарды басу

Тұрақты сұрыптауды пайдаланып, келесі бет қате болса немесе қайтарылған бет шектен қысқа болса тоқтатыңыз.

count=true қосымша есеп сұранысын іске қосуға болады. Оны бірінші сұрау салуда тек жалпы қажет болған кезде ғана жіберіңіз.

Деректер бет аралары өзгеруі мүмкін. Қайталанушы синхрондықтау үшін өзгеріске келмейтін идентификатор арқылы сұрыптау және процес өзгерістерін бөлек үдемелі ағында жасау.

Баспалау цикл · JavaScript
let page = 1;
let hasNextPage = true;

while (hasNextPage) {
  const url = new URL('https://api.selsup.ru/api/brand/find');
  url.searchParams.set('limit', '500');
  url.searchParams.set('page', String(page));
  url.searchParams.set('sortBy', 'BRANDID');
  url.searchParams.set('ascending', 'true');

  const response = await fetch(url, {
    headers: { Authorization: process.env.SELSUP_API_TOKEN }
  });
  if (!response.ok) throw await response.json();

  const result = await response.json();
  await savePage(result.rows);
  hasNextPage = result.hasNextPage;
  page += 1;
}

04

Өндірістік тексеру тізімі

  1. 1

    Оқу және жазуды бөлек

    GET сұрақтарын бірінші орындаңыз. Мутацияларды тексеру үшін тесттік субъектілерді және нақты растау қадамдарын қолданыңыз.

  2. 2

    Уақытша және қайта сынақтарды баптау

    Тек желілік қателерді және қауіпсіз операцияларды қайталап көріңіз. POST өз IDEMPotency кілтісіз қосарланған файл жасауға болады.

  3. 3

    Бір уақыттағы шектілік

    Аяқ нүктелерінің шегін құрметтеңіз және экспрезентативті кері қашықтықпен және шағын кездейсоқ дыршықпен кезекті пайдаланыңыз.

  4. 4

    Нәтижелерді салыстыру

    Үлгілі синхроннан кейін сандарды және үлгіні сәйкестендірушілерді салыстырып, кейін айырмашылықтарды бөлек кезекке көшіріңіз.

!
Тікелей шот деректері

Бұл сұрау салуды токен иелерінің тіркелгісіне жібереді. Құжаттама жазулар үшін растауды қосады, бірақ сіз әлі де сынақ жазбаларын пайдалану керек.