رموز الأخطاء

كل الأخطاء التي قد تعيدها Gurdx برمزها ونوعها ومعناها، مع طريقة التعامل معها في شيفرتك.

غلاف الخطأ#

تُسلَّم الأخطاء برمز HTTP 200 وبمحتوى بهذا الشكل:

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

الرموز 101 إلى 127 هي المجموعة الأساسية، والرموز 128 إلى 132 إضافات لاحقة.

كل الرموز#

التعامل مع الأخطاء#

بما أن رمز HTTP يكون 200 حتى في الأخطاء، افحص الحقل status في المحتوى.

PHP#

$res = Http::withToken(env('GURDX_KEY'))->get('https://gurdx.cretip.com/api/lookup/ip', ['ip' => $ip])->json();

if (($res['status'] ?? null) === 'error') {
    match ($res['code']) {
        106 => usleep(500_000),            // خفّف السرعة وأعد المحاولة لاحقاً
        103, 105, 127 => notifyBilling(),  // الحصة أو الاشتراك
        101, 113 => alertOps($res),        // مشكلة في المفتاح أو المضيف
        default => logger()->warning('Gurdx error', $res),
    };
    return fallbackDecision();
}

$data = $res['data'];

JavaScript#

const res = await fetch("https://gurdx.cretip.com/api/lookup/ip?ip=1.1.1.1", {
  headers: { Authorization: "Bearer " + process.env.GURDX_KEY },
}).then((r) => r.json());

if (res.status === "error") {
  if (res.code === 106) await new Promise((r) => setTimeout(r, 500));
  throw new Error(`Gurdx ${res.code} ${res.type}: ${res.description}`);
}
console.log(res.data);

Python#

import requests

res = requests.get(
    "https://gurdx.cretip.com/api/lookup/ip",
    params={"ip": "1.1.1.1"},
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    timeout=5,
).json()

if res.get("status") == "error":
    raise RuntimeError(f"Gurdx {res['code']} {res['type']}: {res['description']}")
data = res["data"]

أي الأخطاء تستحق إعادة المحاولة#

Tip: سجّل code وtype مع الدالة التي استدعيتها، فهذا يسهّل تشخيص الحوادث كثيراً.

الصيغة والأخطاء#

تحترم الأخطاء خيار format إذا كان صالحاً، فيتلقى عميل XML خطأً بصيغة XML. أما إذا كانت قيمة format نفسها غير صالحة (108) أو تعارضت مع callback (109) فيُعاد الخطأ بصيغة JSON.