> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryoto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# نظرة عامة على OTO API

> ابنِ على OTO API التي تضم 76 نقطة نهاية REST للطلبات والمراكز والشحنات وشركات الشحن، إلى جانب خدمات الويب هوك وبيئة التجربة ومجموعة Postman.

كل ما تقوم به لوحة التحكم، تقوم به واجهة API أيضًا. إذا كنت تشغّل OTO في الخلفية تحت نظامك الخاص، سواء كان متجرًا إلكترونيًا أو نظام ERP أو WMS أو سوقًا إلكترونية، فهذه هي الواجهة كاملةً.

## ما الذي يمكنك بناؤه؟

صُممت واجهة API حول الكائنات نفسها الموجودة في المنصة، ولذلك ينتقل التصور الذهني كما هو: يصل **طلب**، فيُسند إلى **مركز**، ثم تُحجز **شحنة** مع **شركة شحن**، ويُبلَّغ العميل. أربعة أفعال، و**76 نقطة نهاية** موزعة على **20 مجموعة**.

| إذا كنت تريد… | ابدأ من |
| - | - |
| إدخال الطلبات من نظام لا يتوفر له ربط جاهز | [التوثيق](https://docs.tryoto.com/ar/developers/authentication.md)، ثم `createOrder` |
| عرض خيارات الشحن ومواعيد التوصيل مباشرةً في صفحة الدفع | [Checkout API](https://docs.tryoto.com/ar/modules/sales-channels/checkout-api.md) |
| أن تُبلَّغ عند حدوث أي تغيير بدلًا من الاستعلام المتكرر | [Webhooks](https://docs.tryoto.com/ar/developers/webhook-events.md) |
| تشغيل نظام WMS خاص بك ومزامنة المخزون باستمرار | Stock Management، في [فهرس نقاط النهاية](https://docs.tryoto.com/ar/developers/rest-api-reference.md) |
| إعادة بيع خدمات OTO للبائعين لديك | Marketplace، في [فهرس نقاط النهاية](https://docs.tryoto.com/ar/developers/rest-api-reference.md) |

## شكل عملية الربط

معظم عمليات الربط تتكون من الاستدعاءات الخمسة نفسها، وبالترتيب نفسه. وبقية الواجهة موجودة للحالات المحيطة بها.

| # | الاستدعاء | السبب |
| - | - | - |
| 1 | `POST /rest/v2/refreshToken` | الحصول على رمز الوصول (Access Token). مرة كل ساعة، لا مع كل طلب. |
| 2 | `POST /rest/v2/createOrder` | أصبح الطلب موجودًا في OTO ويخضع لقواعد [توجيه الطلبات](https://docs.tryoto.com/ar/modules/omnichannel-oms/order-routing.md). |
| 3 | `POST /rest/v2/checkOTODeliveryFee` | اختياري. يعرض الخيارات والأسعار المتاحة إذا أردت الاختيار بنفسك بدلًا من ترك الاختيار للأتمتة. |
| 4 | `POST /rest/v2/createShipment` | تُحجز شركة الشحن وتصدر بوليصة الشحن (AWB). |
| 5 | `POST /rest/v2/webhook` | يُسجَّل مرة واحدة، لا لكل طلب. وكل ما يحدث بعد ذلك يُرسل إليك تلقائيًا. |

> [!TIP]
>
> **الخطوة 5 هي التي يتجاوزها الكثيرون**
>
> من المغري الاستعلام عن `orderStatus` على فترات زمنية ثابتة، لأن ذلك يعمل من اليوم الأول دون الحاجة إلى استضافة نقطة نهاية خاصة بك.
>
> لكنه يتوقف عن العمل مع زيادة الحجم: إذ تُجري آلاف الاستدعاءات لتعرف أن شيئًا لم يتغير، والحالة التي تحتاجها فعلًا تصلك متأخرة بمقدار فترة الاستعلام. أما إعداد Webhook فلا يستغرق أكثر من صباح عمل، ويحل المشكلة نهائيًا.

## أين تجدها؟

| المورد | المكان |
| - | - |
| **رمز التحديث (Refresh Token) الخاص بك** | **الإعدادات ← API Integrations ‏← Connect** |
| **مخططات الطلبات والاستجابات كاملةً** | [apis.tryoto.com](https://apis.tryoto.com) — المرجع المباشر، مع أمثلة بأكثر من 30 لغة برمجة |
| **عنوان URL الأساسي لبيئة الإنتاج** | `https://api.tryoto.com` |
| **عنوان URL الأساسي لبيئة التجربة (Sandbox)** | `https://staging-api.tryoto.com` |

## في هذا القسم

> **[التوثيق](https://docs.tryoto.com/ar/developers/authentication.md)**
>
> الرموز والترويسات وبيئة التجربة وتوفر الخدمة حسب الباقة.

> **[مرجع REST API](https://docs.tryoto.com/ar/developers/rest-api-reference.md)**
>
> نقاط النهاية الـ 76 كاملةً، مع الباقة التي تتطلبها كل منها.

> **[أحداث Webhook](https://docs.tryoto.com/ar/developers/webhook-events.md)**
>
> أنواع الأحداث الثلاثة، والبيانات المرسلة (Payload)، والتحقق من التوقيع.

> **[مجموعة Postman](https://docs.tryoto.com/ar/developers/postman-collection.md)**
>
> شغّل كل نقاط النهاية على بيئة التجربة دون كتابة أي كود.

> **[الأخطاء وحدود الاستخدام](https://docs.tryoto.com/ar/developers/errors-and-rate-limits.md)**
>
> كيف يبدو الفشل، وكيف تتعامل معه.

## الأنظمة المرتبطة بها

* [قنوات البيع](https://docs.tryoto.com/ar/modules/sales-channels/overview.md) — عمليات الربط الجاهزة، عندما لا تحتاج إلى بناء ربط بنفسك.
* [مزامنة الطلبات](https://docs.tryoto.com/ar/modules/omnichannel-oms/order-sync.md) — ما يحدث للطلب الذي ترسله.
* [إدارة المراكز](https://docs.tryoto.com/ar/modules/hubs-management/overview.md) — نقاط استلام الطلب، وتُنشأ هنا بوصفها مراكز.


## Related topics

- [نظرة عامة على عمليات الربط](https://docs.tryoto.com/ar/integrations/overview.md)
- [مزودو الرسائل النصية والبريد الإلكتروني وواتساب](https://docs.tryoto.com/ar/integrations/messaging-providers.md)
- [الربط مع أنظمة POS](https://docs.tryoto.com/ar/integrations/pos-systems.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.