وثائق API

الوصول إلى واجهة RESTful API الخاصة بنا لدمج أدوات تشخيص شبكة IPv6 في تطبيقاتك. جميع نقاط النهاية تُرجع استجابات JSON وتدعم كلاً من IPv4 و IPv6.

عنوان URL الأساسي

Bash

https://ping6.net/api/v1

HTTPS فقط

يجب أن تستخدم جميع طلبات API بروتوكول HTTPS للاتصال الآمن.

CORS مُفعّل

يتم دعم الطلبات عبر النطاقات من أي نطاق.

المصادقة

معظم نقاط النهاية متاحة بدون مصادقة. للحصول على حدود معدل أعلى والوصول إلى الميزات المتميزة، استخدم مفتاح API.

مجهول

لا حاجة للمصادقة. تخضع لحدود معدل أقل.

مفتاح API

قم بتضمين مفتاح API الخاص بك في رأس X-API-Key للحصول على حدود معدل أعلى.

Bash

curl -X GET "https://ping6.net/api/v1/ping/google.com" \
  -H "X-API-Key: your-api-key-here"

حدود المعدل

طلبات API محدودة المعدل لضمان الاستخدام العادل وتوفر الخدمة.

المستوى	الطلبات	ملاحظات
مجهول	100 / minute	تحديد مبني على IP. مشترك بين جميع المستخدمين المجهولين من نفس IP.
مفتاح API	1,000 / minute	لكل مفتاح API. اتصل بنا للحصول على حدود أعلى.

رؤوس حد المعدل

X-RateLimit-Limitالحد الأقصى للطلبات المسموح بها لكل نافذة

X-RateLimit-Remainingالطلبات المتبقية في النافذة الحالية

X-RateLimit-Resetطابع Unix الزمني عند إعادة تعيين حد المعدل

معالجة الأخطاء

تستخدم API رموز استجابة HTTP التقليدية للإشارة إلى النجاح أو الفشل.

الرمز	الحالة	الوصف
400	Bad Request	معلمات طلب غير صالحة أو نص طلب مشوه.
401	Unauthorized	مفتاح API غير صالح أو مفقود لنقاط النهاية المحمية.
404	Not Found	المورد أو نقطة النهاية المطلوبة غير موجودة.
429	Too Many Requests	تم تجاوز حد المعدل. انتظر قبل إجراء المزيد من الطلبات.
500	Internal Server Error	خطأ في الخادم. يرجى المحاولة لاحقاً أو الاتصال بالدعم.

JSON

{
  "error": {
    "code": "INVALID_ADDRESS",
    "message": "The provided address is not a valid IPv6 address",
    "details": {
      "address": "invalid-address"
    }
  }
}

نقاط نهاية API

GET/myip

الحصول على عنوان IP الخاص بي

يُرجع عنوان IP العام للعميل الذي يُجري الطلب. يكتشف تلقائياً ما إذا كان الاتصال IPv4 أو IPv6.

Example Response

JSON

{
  "ip": "2001:db8:85a3::8a2e:370:7334",
  "version": 6,
  "isIPv6": true
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/myip" \
  -H "Accept: application/json"

GET/validate

التحقق من عنوان IPv6

يتحقق من عنوان IPv6 ويُرجع معلومات مفصلة حول تنسيقه ونوعه وتمثيلاته القانونية.

Parameters

Name	Type	In	Description
`address`*	string	query	عنوان IPv6 للتحقق منه

Example Response

JSON

{
  "valid": true,
  "type": "Documentation",
  "compressed": "2001:db8::1",
  "expanded": "2001:0db8:0000:0000:0000:0000:0000:0001"
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/validate?address=2001:db8::1" \
  -H "Accept: application/json"

GET/dns/{hostname}

استعلام DNS

استعلام سجلات DNS لاسم مضيف باستخدام محللات DNS قابلة للتكوين. يدعم جميع أنواع السجلات الشائعة مع التركيز بشكل خاص على سجلات AAAA لـ IPv6.

Parameters

Name	Type	In	Description
`hostname`*	string	path	اسم المضيف للاستعلام عنه
`type`	enum: AAAA \| A \| MX \| TXT \| NS \| CNAME \| SOA \| PTR	query	نوع سجل DNS للاستعلام عنه(default: `AAAA`)
`resolver`	enum: cloudflare \| google \| quad9	query	محلل DNS لاستخدامه في الاستعلام(default: `cloudflare`)

Example Response

JSON

{
  "hostname": "google.com",
  "records": [
    {
      "type": "AAAA",
      "value": "2607:f8b0:4004:800::200e",
      "ttl": 300
    }
  ],
  "resolver": "cloudflare",
  "queryTime": 23
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/dns/google.com?type=AAAA&resolver=cloudflare" \
  -H "Accept: application/json"

GET/ping/{target}Beta

Ping الهدف

إرسال طلبات صدى ICMP إلى عنوان IPv6 أو اسم مضيف واستقبال إحصائيات زمن الوصول. يتطلب مصادقة مفتاح API.

Parameters

Name	Type	In	Description
`target`*	string	path	عنوان IPv6 أو اسم المضيف لعمل ping
`count`	string	query	عدد حزم ping للإرسال (1-10)(default: `4`)

Example Response

JSON

{
  "target": "2001:4860:4860::8888",
  "ip": "2001:4860:4860::8888",
  "results": [
    {
      "seq": 1,
      "ttl": 117,
      "rtt": 12.4
    },
    {
      "seq": 2,
      "ttl": 117,
      "rtt": 11.8
    },
    {
      "seq": 3,
      "ttl": 117,
      "rtt": 12.1
    },
    {
      "seq": 4,
      "ttl": 117,
      "rtt": 11.9
    }
  ],
  "stats": {
    "transmitted": 4,
    "received": 4,
    "loss": 0,
    "min": 11.8,
    "avg": 12.05,
    "max": 12.4
  }
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/ping/2001:4860:4860::8888?count=4" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key"

GET/traceroute/{target}Beta

تتبع المسار

تتبع مسار الشبكة إلى وجهة، مع عرض كل قفزة على طول المسار مع معلومات زمن الوصول. يتطلب مصادقة مفتاح API.

Parameters

Name	Type	In	Description
`target`*	string	path	عنوان IPv6 أو اسم المضيف للتتبع
`maxHops`	string	query	الحد الأقصى لعدد القفزات للتتبع (1-64)(default: `30`)

Example Response

JSON

{
  "target": "google.com",
  "ip": "2607:f8b0:4004:800::200e",
  "hops": [
    {
      "hop": 1,
      "ip": "2001:db8::1",
      "hostname": "router.local",
      "rtt": 1.2
    },
    {
      "hop": 2,
      "ip": "2001:db8:1::1",
      "hostname": "isp-gateway.net",
      "rtt": 5.4
    },
    {
      "hop": 3,
      "ip": "2607:f8b0:4004:800::200e",
      "hostname": "google.com",
      "rtt": 12.8
    }
  ]
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/traceroute/google.com?maxHops=30" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key"