Umumiy ma’lumot

Agar loyihangizda shaxsiy autentifikatsiya tizimi mavjud bo'lsa, vidjetni ishga tushirishda external_user_id parametrini uzatishingiz mumkin. Support serveri ushbu ID asosida foydalanuvchi ma’lumotlarini (ism, telefon, email) olish uchun sizning API’ingizga so‘rov yuboradi.

⚙️ Sozlash bosqichlari

1. Loyiha sozlamalari: Boshqaruv panelidan "API integratsiyasi" bo‘limini yoqing.

2. Endpoint kiritish: Foydalanuvchi ma’lumotlari uchun API URL manzilini ko‘rsating:

   • Dinamik URL: https://api.yoursite.com/users/{id} ({id} avtomatik almashadi).

   • Standart URL: https://api.yoursite.com/users (so'rov ?id=123 ko'rinishida yuboriladi).

3. Xavfsizlik: Agar API maxfiy bo'lsa, Authorization: Bearer <token> kabi sarlavhalarni (headers) kiriting.

API Spetsifikatsiyasi

Vidjet foydalanuvchi bilan muloqotni boshlaganda, tizim quyidagi standartlar asosida GET so‘rovini yuboradi:

Metod: GET

Timeout: 10 soniya

Format: JSON

✅ Muvaffaqiyatli javob formati (200 OK)

Sizning API’ingiz quyidagi strukturada JSON qaytarishi tavsiya etiladi:

JSON

{
  "first_name": "John",
  "last_name": "Doe",
  "phone_number": "+998901234567",
  "email": "user@example.com",
  "metadata": {
    "plan": "Premium",
    "registered_at": "2024-01-30"
  }
}

⚠️ Xatolarni boshqarish

Tizim javob kodlariga qarab quyidagicha yo'l tutadi:

• 200 OK: Ma’lumotlar muvaffaqiyatli qabul qilindi va profil yangilandi.

• 404 Not Found: Foydalanuvchi topilmadi. Vidjet ID bilan anonim rejimda ishlashda davom etadi.

• 401 / 403: Autentifikatsiya xatosi. API kalitlarini yoki sarlavhalarni tekshiring.

• 5xx: Server xatosi. Tizim so‘rovni qayta amalga oshirmaydi.

💡 Foydali maslahatlar

• Tezlik: Endpointingizni optimallashtiring. So‘rov kutish vaqti 10 soniya, sekin javob beradigan API foydalanuvchi ma’lumotlarini ko‘rsatishda kechikishlarga sabab bo‘ladi.

• Metadata: metadata maydonidan maksimal foydalaning (tarif, balans). Bu operatorga foydalanuvchidan ortiqcha savollarni so‘ramay turib yordam berish imkonini beradi.

• Muhim maydonlar: Barcha maydonlar ixtiyoriy bo‘lsa-da, sifatli xizmat uchun kamida first_name va emailni qaytarish tavsiya etiladi.