API دستاویزات
یہ دستی کتابچہ دستیاب API اینڈ پوائنٹس کے لیے ہے، جو REST فن تعمیر کے گرد بنائے گئے ہیں۔ تمام API اینڈ پوائنٹس ایک JSON جواب واپس کریں گے جس میں معیاری HTTP جواب کے کوڈز ہوں گے اور انہیں API کی کے ذریعے بیئرر تصدیق کی ضرورت ہوگی۔
تصدیق
تمام API اینڈپوائنٹس کو ایک API کلید کی ضرورت ہوتی ہے جو Bearer Authentication method کے ذریعے بھیجی جاتی ہے۔
curl --request GET \
--url 'https://kodx.uk/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://kodx.uk/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
تمام API اینڈپوائنٹ کے نتائج UTC ٹائم زون کے ساتھ کام کرتے ہیں جب تک کہ دوسری صورت میں وضاحت نہ کی جائے۔