صيغة الاستجابة

اختر كيف تُرمَّز استجابة Gurdx: JSON أو XML أو CSV أو قيم نصية يفصل بينها سطر جديد.

المعامل format#

أضف format إلى أي طلب. القيمة لا تتأثر بحالة الأحرف، والافتراضي JSON.

القيمة	نوع المحتوى	الاستخدام المعتاد
`JSON`	`application/json`	التطبيقات والواجهات (الافتراضي).
`XML`	`application/xml`	الأنظمة القديمة.
`CSV`	`text/csv`	الجداول والتصدير السريع.
`Newline`	`text/plain`	سكربتات الصدفة؛ قيمة في كل سطر.

القيمة غير المدعومة تعيد الخطأ 108 invalid_format.

JSON#

curl "https://gurdx.cretip.com/api/lookup/country?key=YOUR_API_KEY&countryCode=SA"

{
  "data": { "countryCode": "SA" },
  "status": "success",
  "executionTime": 4
}

XML#

curl "https://gurdx.cretip.com/api/lookup/country?key=YOUR_API_KEY&countryCode=SA&format=XML"

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <data>
    <countryCode>SA</countryCode>
  </data>
  <status>success</status>
  <executionTime>4</executionTime>
</response>

تتحول القوائم إلى عناصر <item> متكررة، وتُنظَّف المفاتيح التي لا تصلح اسماً لعنصر XML (يُضاف شرطة سفلية قبل الرقم في البداية).

CSV#

تتكون الاستجابة من سطرين: سطر ترويسة بأسماء المفاتيح بعد تسطيحها وسطر واحد للقيم. المفاتيح المتداخلة تُكتب بالنقطة.

data.countryCode,status,executionTime
SA,success,4

Newline#

القيم فقط، قيمة في كل سطر، بالترتيب نفسه لأسماء المفاتيح المسطّحة.

SA
success
4

القيم المنطقية تُكتب true أو false، والقيم الفارغة تُكتب نصاً فارغاً.

الأخطاء بالصيغ الأخرى#

يُرمَّز الخطأ بالصيغة المطلوبة، فيتلقى عميل CSV خطأً بصيغة CSV:

status,code,type,description
error,101,invalid_key,The API Key is missing or invalid.

ويبقى رمز HTTP هو 200. راجع رموز الأخطاء.

ذو صلة#

JSONP يعمل مع JSON فقط (وإلا ظهر الخطأ 109).
تحمل كل استجابة أيضاً الترويسة X-Gurdx-Execution-Time بزمن المعالجة بالميلي ثانية.

وجدت خطأ؟ أخبرنا عبر صفحة التواصل. تواصل معنا