Integratsiya asoslari · Yoʻlboshchilar
Boshlanmoqda
Tasdiqlash, birinchi so'rov, mahalliy xatolar, sahifalar va xavfsiz ishlab chiqarish yo'llanmasi.
error-ni boshqarish va qayta sinab ko'rishdan so'ng mutatsiyalarni qo'shing.
Orqa tomonni ishlab chiquvchilar va integratorlar01
Tasdiqlash va tokenlarni saqlash
API tokenini Authorization sarlavhasida Bearer prefiksisiz to'g'ridan-to'gʻri yuboring.
Har bir integratsiya uchun alohida token yaratish. Keyin siz boshqalarni kesmasdan bir aloqa bekor qilishingiz va faqat kerakli ruxsatlarni berishingiz mumkin.
Tokeni server tomonidan sirda saqlang. Uni hech qachon brauzer JavaScript, mobil dastur, URL, log yoki analitikaga jo'natmang.
Bearer yoki Basic qo'shmang. Authorization qiymati SelSup belgisi hisoblanadi.
curl --request GET 'https://api.selsup.ru/api/brand/find?limit=50&page=1' \
--header 'Authorization: YOUR_API_TOKEN'
API bilan bog'liq oxirgi nuqtalar
GET/api/brand/findXavfsiz sinov talablari
02
Xatolar va xabar joylari
error o'zidan-o'zini o'zgartiradigan xonada bo'ling va localMessage-ni faqat inson o'qishi mumkin bo'lgan chiqindilar uchun ishlating.
error dasturida error, localMessage va params mavjud. Server localMessage-ni token egasi foydalanuvchining lang maydoni yordamida tarjima qiladi.
Hujjat tili va Accept-Language error lokalini o'zgartirib bo'lmaydi. localMessage kodini hech qachon taqqoslamang yoki uni mashina holati sifatida saqlang.
HTTP holati, error, params, so'rov vaqti va bog'lanish identifikatoringizni yozib oling. Token yoki shaxsiy ma'lumotlarni hech qachon yozib qo'ymang.
{
"error": "brand_already_exists",
"localMessage": "Brand Base already exists",
"params": {
"name": "Base"
}
}
03
Katta to'plamlarni ko'rish
Agar "NextPage" xato yoki qaytarilgan sahifa cheklanganidan qisqacha bo'lsa, barqaror sinflashdan foydalaning va to'xtating.
count=true qo'shimcha hisob so'rovini qo'zg'atishi mumkin. Uni faqat umumiy bo'lganda birinchi so'roviga yuboring.
Ma'lumotlar sahifalar o'rtasida o'zgarib turishi mumkin. Takrorlanuvchi sinxronlashtirish uchun o'zgarmas identifikatorga qarab tartiblash va alohida o'sish oqimida o'zgartirishlarni amalga oshirish.
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;
}
API bilan bog'liq oxirgi nuqtalar
GET/api/brand/findSahifalar bilan qidirish namunalariGET/api/product/findMahsulot qidiruv
04
Ishlab chiqarish tekshiruv ro'yxati
- 1
O'qish va yozishning alohida qismi
GET talablarini avval tasdiqlang. Mutasiyalar uchun test entitetlari va aniq tasdiqlanish bosqichidan foydalaning.
- 2
Vaqtni oʻtkazish va qayta urinishlarni moslash
Faqat tarmoq xatolari va xavfsiz operatsiyalarni qayta ko'rib chiqing. POST o'zingizning idempotency kalitingizsiz nusxa yaratishi mumkin.
- 3
Bir vaqtning o'zida cheklov
Oxirgi nuqtalar chegaralarini hurmat qiling va eksponensial orqaga chiqish va kichik tasodifiy jitter bilan navbatdan foydalaning.
- 4
Natijalarni birlashtiring
Ko'pchilik sinxronlashtirgandan so'ng, san'at va namuna identifikatorlarini taqqoslang va o'zaro farqlarni alohida navbatga o'tkazing.
Imtixor qilish so'rovni token egasining hisob raqamiga yuboradi. Hujjatlar yozish uchun tasdiq qo'shadi, lekin siz hali ham sinov yozuvlaridan foydalanishingiz kerak.