توثيق APIالوثائق التقنية

توثيق API من أوصاف نقاط النهاية لديك

جاهز عادةً خلال 15 دقيقةالتعديلات مشمولةفحص الجودة
الباقات
حماية الدفعالتفاصيل
  • التعديلات ضمن الباقة مجانية.
  • إذا لم تردّ خلال 3 أيام من التسليم، يُقبل العمل تلقائيًا.

يُحجز المبلغ عند الدفع ولا يُحوَّل إلا بعد قبولك العمل.

توثيق API من أوصاف نقاط النهاية لديك

مثال على النتيجة

مثال على الباقة القياسية

توثيق واجهة برمجة: واجهة لتتبع الطرود للمتاجر الإلكترونية

البدء السريع

  1. احصل على مفتاح الواجهة من Dashboard ← Settings ← API keys.
  2. أرسل كل طلب مع الترويسة Authorization: Bearer <your_key>.
  3. العنوان الأساسي: https://api.trackpoint.example/v1

جلب شحنة

GET /shipments/{tracking_number}

يُرجع الحالة الحالية وسجل الأحداث لطرد واحد.

المعاملالموضعإلزاميالوصف
tracking_numberpathنعمرقم التتبع لدى شركة الشحن، من 8 إلى 30 حرفًا
langqueryلالغة نصوص الحالة: en، de، fr. الافتراضي: en

مثال على الطلب

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

مثال على الاستجابة (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

الأخطاء

الرمزالمعنىما العمل
401مفتاح الواجهة مفقود أو خاطئتحقق من ترويسة Authorization
404رقم التتبع غير موجودقد تحتاج شركات الشحن إلى ساعتين لتسجيل طرد جديد
429أكثر من 100 طلب في الدقيقةانتظر المدة المذكورة في ترويسة Retry-After

ما تم تسليمه

توثيق نقاط النهاية الـ 14 كلها بصيغة Markdown، جاهز لموقع التوثيق لدى العميل، وقائمة بـ 3 مواضع تصرفت فيها الواجهة بخلاف الأوصاف، أُرسلت إلى المطورين.

العميل: Trackpoint، شركة ناشئة تتيح واجهتها REST للمتاجر الإلكترونية عرض حالة الطرود؛ أرسل المطورون أوصافًا مختصرة لـ 14 نقطة نهاية ومجموعة من الطلبات النموذجية المطلوب: دليل بدء سريع ومرجع لنقاط النهاية يستطيع المطور اتباعه خلال 15 دقيقة؛ وفيما يلي مقتطف

العميل وجميع التفاصيل افتراضية.

عن هذه الخدمة

يحكم المطورون على أي API من توثيقها خلال دقائق: إذا لم تنجح المصادقة أو الطلب الأول، يغادرون. نكتب مرجع API والأدلة من أوصاف نقاط النهاية أو ملف OpenAPI أو أمثلة الشيفرة لديك: المصادقة، وعناوين URL الأساسية، وكل نقطة نهاية بمعاملاتها، وأمثلة الطلبات والاستجابات، ورموز الأخطاء، وحدود المعدل، والتقسيم إلى صفحات. ويعرض دليل البدء السريع أول استدعاء ناجح في خطوات قليلة.

ما المشمول

  • ما الذي تحصل عليهتوثيق API بصيغة Markdown مع كتل الشيفرة، جاهز لـ ReadMe أو GitBook أو Docusaurus أو مستودعك. نكتب مما ترسله ولا نستدعي API الخاصة بك بأنفسنا.
  • البدء السريعمن مفتاح API إلى أول استدعاء
  • مرجع نقاط النهايةالمعاملات، الأنواع، الأمثلة
  • الأخطاء والحدودالرموز، المعاني، نصائح إعادة المحاولة
  • أمثلة الشيفرةcURL إضافةً إلى لغة واحدة تختارها
  • مصطلحات متسقةالأسماء نفسها كما في مخططك

كيف يعمل

  1. 1
    متطلبات الطلبتلصق أو ترفق نقاط النهاية والأمثلة
  2. 2
    الهيكل والكتابةنكتب المرجع والأدلة
  3. 3
    التسليمتستلم Markdown جاهزًا للنشر

ما نحتاجه منك

أوصاف نقاط النهاية أو ملف OpenAPI أو Postman ملصوقًا كنص، وتفاصيل المصادقة، وأمثلة الطلبات والاستجابات، ورموز الأخطاء، ومن هم مستخدمو API لديك.

سنسألك:

  • ماذا تفعل API، ومن يستخدمها؟
  • كيف تعمل المصادقة؟
  • ما اللغة التي يجب أن تستخدمها أمثلة الشيفرة إلى جانب cURL؟
  • أين سيُنشر التوثيق؟

قارن بين الباقات

الباقاتالأساسية‏19 US$القياسية‏39 US$المميزة‏79 US$
ما المشمولبدء سريع وحتى 5 نقاط نهايةحتى 20 نقطة نهاية مع أدلةحتى 50 نقطة نهاية، توثيق كامل
مدة التنفيذ1 يوم3 أيام5 أيام
التعديلات123
الطولحتى 2,000 كلمةحتى 6,000 كلمةحتى 14,000 كلمة
نقاط النهايةحتى 5حتى 20حتى 50
لغات أمثلة الشيفرةcURLcURL + 1cURL + 2
اطلب الأساسيةاطلب القياسيةاطلب المميزة

حماية الدفع

تدفع عند الطلب، لكن المبلغ لا يُحوَّل إلا مقابل عمل قبلته.

  • سعر ثابتلا يتغير سعر الباقة بعد الدفع.
  • المبلغ محجوزعند الدفع، يُحجز المبلغ فقط. ولا يُحوَّل إلى Dleex إلا بعد قبولك العمل.
  • فحص قبل التسليمتخضع كل نتيجة لفحص الجودة قبل أن تصل إليك، وتراها في صفحة الطلب قبل قبولها.
  • تعديلات مجانيةاطلب تعديلات ضمن متطلبات طلبك بالعدد الذي تسمح به الباقة.
  • القبول بعد 3 أيامإذا لم تقبل العمل ولم تطلب تعديلات خلال 3 أيام من التسليم، يُقبل تلقائيًا. وإذا كتبت في محادثة الطلب بعد التسليم، يبقى الطلب قيد الانتظار؛ وبعد ردّنا، قد نعيد بدء مهلة 3 أيام وسنُعلمك بذلك في المحادثة.
  • إعادة التنفيذ أو استرداد المبلغ كاملًاإذا لم تطابق النتيجة متطلبات طلبك ولم تُصلحها التعديلات، أو استغرق العمل أكثر من ضعف مدة التنفيذ، فاكتب في محادثة الطلب: سنعيد تنفيذ العمل أو نردّ إليك المبلغ كاملًا.
كيف يعمل →

الأسئلة والأجوبة

هل يمكنكم العمل من مواصفات OpenAPI الخاصة بنا؟

نعم، الصق ملف YAML أو JSON في متطلبات الطلب. نحوّل أوصافه إلى صفحات مرجعية مقروءة ونملأ الثغرات التي تشير إليها.

هل ستختبرون الأمثلة؟

لا نستدعي API الخاصة بك. تُبنى الأمثلة من نماذج الطلبات والاستجابات التي ترسلها، لذا شغّلها مرة واحدة قبل النشر.

هل تكتبون توثيق SDK؟

نعم، إذا أرسلت تواقيع الدوال وأمثلة الاستخدام. تُحتسب كل SDK ضمن حجم الباقة.

لم تجد إجابتك؟

الباقات