شبكة نمو

المحتويات

تنزيل الوثائق بصيغة Markdown

وثائق واجهة برمجة التطبيقات (API) لشبكة نمو

مرحبًا بك في وثائق واجهة برمجة التطبيقات (API) لشبكة نمو، المنصة الاحترافية لاختصار الروابط وإنشاء رموز QR. توفر هذه الوثائق كل ما تحتاجه للبدء في استخدام API الخاص بنا في تطبيقاتك.

الاستعداد السريع:

  1. قم بإنشاء حساب في شبكة نمو
  2. قم بتسجيل الدخول إلى حسابك
  3. قم بإنشاء مفتاح API من صفحة لوحة التحكم
  4. استخدم المفتاح في طلبات API الخاصة بك بتنسيق Authorization: Bearer {token}

معلومات عامة

  • عنوان الخادم الأساسي: https://numo-url.com/api
  • النسخة الحالية: v1
  • تنسيق الاستجابة: JSON
  • المصادقة: Bearer Token (OAuth 2.0)

المصادقة

تستخدم واجهة API نظام المصادقة بواسطة الرموز المميزة (Tokens) من خلال Laravel Sanctum.

POST /auth/register

تسجيل مستخدم جديد

المعلمات المطلوبة:

  • name: اسم المستخدم
  • email: البريد الإلكتروني
  • password: كلمة المرور
  • password_confirmation: تأكيد كلمة المرور

مثال للاستجابة:

{
  "message": "تم تسجيل المستخدم بنجاح",
  "user": {
    "id": 1,
    "name": "أحمد محمد",
    "email": "ahmed@example.com",
    "created_at": "2023-06-01T12:00:00.000000Z",
    "updated_at": "2023-06-01T12:00:00.000000Z"
  },
  "access_token": "1|5Ya7DrCs9MK2hVDJxJ09T7wqArftUYcBdfMkBRVY",
  "token_type": "Bearer"
}
POST /auth/login

تسجيل الدخول وإصدار رمز الوصول

المعلمات المطلوبة:

  • email: البريد الإلكتروني
  • password: كلمة المرور
  • logout_others (اختياري، boolean): إلغاء جميع جلسات الدخول الأخرى

مثال للاستجابة:

{
  "message": "تم تسجيل الدخول بنجاح",
  "user": {
    "id": 1,
    "name": "أحمد محمد",
    "email": "ahmed@example.com",
    "created_at": "2023-06-01T12:00:00.000000Z",
    "updated_at": "2023-06-01T12:00:00.000000Z"
  },
  "access_token": "1|5Ya7DrCs9MK2hVDJxJ09T7wqArftUYcBdfMkBRVY",
  "token_type": "Bearer"
}

الروابط المختصرة

POST /v1/shortener/shorten

اختصار رابط

المعلمات المطلوبة:

  • url: الرابط الأصلي المراد اختصاره
  • code (اختياري): الرمز المخصص للرابط المختصر

مثال للاستجابة:

{
  "short_url": "https://numo-url.com/abc123"
}

رموز QR

الملف الشخصي

لوحة التحكم

أكواد الخطأ

  • 400 - طلب خاطئ
  • 401 - غير مصرح (مشكلة في المصادقة)
  • 403 - محظور (لا تملك الصلاحيات)
  • 404 - غير موجود
  • 409 - تعارض (مثل محاولة استخدام رمز مختصر موجود مسبقًا)
  • 422 - خطأ في التحقق من البيانات
  • 429 - طلبات كثيرة جدًا (تم تجاوز حد الطلبات)
  • 500 - خطأ في الخادم

الحدود والقيود

  • عدد الطلبات المسموح بها: 60 طلب في الدقيقة للمستخدمين العاديين، 1000 طلب في الدقيقة للمشتركين في الباقات المدفوعة
  • الحد الأقصى لحجم الطلب: 2MB
  • الحد الأقصى لطول الرابط الأصلي: 2048 حرف
  • الحد الأقصى لطول الرمز المخصص: 30 حرف
  • الأحرف المسموح بها في الرمز المخصص: a-z، A-Z، 0-9، _، -

معلومات الاتصال

للحصول على مساعدة إضافية أو لطرح أسئلة حول واجهة برمجة التطبيقات (API)، يرجى التواصل مع: