RouteMateRouteMate
واجهة API للمطورين

ابن مع RouteMate

اربط منصتك عبر REST API الخاصة بنا. استورد التوقفات من متجر التجارة الإلكترونية لديك، وشغّل تحسين المسارات، وتتبع عمليات التوصيل برمجيا.

واجهة RouteMate API
POST /v1/integration-import

الطلب

{
  "external_job_id": "BATCH-001",
  "title": "Morning Deliveries",
  "driver_email": "driver@example.com",
  "stops": [
    {
      "external_stop_id": "STOP-1",
      "address": "1 George St, Brisbane QLD 4000",
      "label": "Customer A",
      "parcel_count": 2
    }
  ]
}

الاستجابة

{
  "job_id": "e7ad097b-...",
  "optimization": {
    "total_distance_km": 12.4,
    "total_duration_minutes": 25
  },
  "stops": [ /* optimized order */ ],
  "warnings": [...]
}

احصل على بيانات الاعتماد

أنشئ client ID و secret من صفحة إعدادات لوحة RouteMate.

اطلب الرمز

بدّل بياناتك للحصول على bearer token صالح لمدة ساعة واحدة.

استدع واجهة API

أضف الرمز إلى ترويسة Authorization لطلبات الاستيراد وحالة الشحنات.

المصادقة

تدفق بيانات اعتماد العميل

تستخدم واجهة RouteMate API تدفق OAuth2 من نوع client credentials. بدّل معرّف العميل والسر للحصول على bearer token قصير العمر، ثم أرسله في ترويسة Authorization.

01

احصل على بيانات الاعتماد

أنشئ client ID و secret من صفحة إعدادات لوحة RouteMate.

02

اطلب الرمز

بدّل بياناتك للحصول على bearer token صالح لمدة ساعة واحدة.

03

استدع واجهة API

أضف الرمز إلى ترويسة Authorization لطلبات الاستيراد وحالة الشحنات.

API

نقاط API الأساسية

تغطي هذه النقاط أكثر مهام التكامل شيوعا في سير عمل التوصيل.

POST/v1/integration-token

احصل على access token

بدّل بيانات client credentials الخاصة بك برمز وصول مؤقت صالح لمدة ساعة.

الطلب

{
  "client_id": "rm_ci_your_client_id",
  "client_secret": "rm_cs_your_client_secret"
}

الاستجابة

{
  "access_token": "rm_at_e5988dd1b91a...",
  "token_type": "Bearer",
  "expires_in": 3600
}
POST/v1/integration-import

استورد مهمة وحسّن المسار

أرسل مهمة تحتوي على التوقفات، ورمّز العناوين جغرافيًا، وحسّن الترتيب، ثم عيّن المهمة إلى السائق.

الطلب

{
  "external_job_id": "BATCH-001",
  "title": "Morning Deliveries",
  "driver_email": "driver@example.com",
  "stops": [
    {
      "external_stop_id": "STOP-1",
      "address": "1 George St, Brisbane QLD 4000",
      "label": "Customer A",
      "parcel_count": 2
    }
  ]
}

الاستجابة

{
  "job_id": "e7ad097b-...",
  "optimization": {
    "total_distance_km": 12.4,
    "total_duration_minutes": 25
  },
  "stops": [ /* optimized order */ ],
  "warnings": [...]
}
GET/v1/integration-jobs

تحقق من حالة المهمة

اطلع في أي وقت على حالة المهمة، وتقدم التوقفات، ونتائج التسليم.

الطلب

// GET request

الاستجابة

{
  "job_id": "e7ad097b-...",
  "status": "assigned",
  "stop_count": 3,
  "status_counts": {
    "pending": 2,
    "completed": 1
  },
  "stops": [...]
}
أمثلة كود

ابدأ خلال دقائق

استخدم الأمثلة أدناه للمصادقة واستيراد المهام والتحقق من حالة التسليم.

curl
curl -X POST https://api.routemate.app/v1/integration-token \
  -H "Content-Type: application/json" \
  -d '{"client_id":"rm_ci_your_client_id","client_secret":"rm_cs_your_client_secret"}'
node
const tokenRes = await fetch("https://api.routemate.app/v1/integration-token", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    client_id: "rm_ci_your_client_id",
    client_secret: "rm_cs_your_client_secret",
  }),
});
python
import requests

token_res = requests.post(
    "https://api.routemate.app/v1/integration-token",
    json={
        "client_id": "rm_ci_your_client_id",
        "client_secret": "rm_cs_your_client_secret",
    },
)
مصمم لفرق SaaS

جاهز للإنتاج من اليوم الأول

مصمم لعمليات توصيل موثوقة، وإعادة المحاولة، والعمليات اللاحقة.

مصادقة آمنة
رموز bearer قصيرة العمر وتبادل مضبوط لبيانات الاعتماد.
استيراد سريع
أرسل عمليات التوصيل من نظامك بطلب واحد.
إعادة محاولة موثوقة
استخدم مفاتيح idempotency لإعادة الطلبات الفاشلة بأمان.
وضوح الحالة
تتبع المهام وتقدم التوقفات برمجيا.

هل تحتاج إلى تكامل مخصص؟

تحدث معنا حول سير عمل الشركاء، والتهيئة المخصصة، والوصول إلى Enterprise API.