رؤوس الطلب

تحتاج جميع طلبات API إلى مفتاح API. سجّل مجانًا لتحصل على مفتاحك و1,000 رصيد كل شهر.

  • Content-Type: application/json (مطلوب لطلبات POST)
  • Accept: application/json (اختياري لكن موصى به)
  • X-API-Key: مفتاح API الخاص بك (احصل على مفتاح مجاني من /dashboard)
  • Authorization: Bearer your-api-key (بديل لـ X-API-Key)
  • Idempotency-Key: اختياري، في طلبات POST التي تخصم رصيداً. تؤدي إعادة المحاولة بالمفتاح نفسه وبطلب مطابق خلال 24 ساعة إلى إرجاع الاستجابة المخزنة مع Idempotent-Replayed: true ودون خصم جديد. أما إعادة استخدام مفتاح لطلب مختلف فتُرجع 422 IDEMPOTENCY_KEY_REUSED، وإرسال طلب مكرر بينما لا يزال الأول قيد التشغيل يُرجع 409 IDEMPOTENCY_IN_PROGRESS. لا تُخزَّن الاستجابات الأكبر من 1 MiB ولا الأخطاء التي رُد مبلغها، لذا تعمل إعادة المحاولة بشكل طبيعي. المفاتيح من 1 إلى 255 محرفاً من محارف ASCII القابلة للطباعة، مثل UUID.
  • DomScan-Naming: اختياري. تؤدي القيمة snake إلى إرجاع كل مفاتيح الاستجابة المكتوبة بنمط camelCase بنمط snake_case، وهو مطابق لاستخدام naming=snake. وعند إرسال الاثنين معًا تكون الأولوية لمعامل الاستعلام. راجع مفاتيح snake_case.