خاصية - واجهة API الطلبات

واجهة برمجة التطبيقات (API) لأوامر الشراء والردود الخاصة بـ Peppol

يمكنك إرسال واستلام أوامر الشراء عبر Peppol، وتنفيذ بقية مراحل عملية الطلب من خلال نفس واجهة برمجة التطبيقات (REST API): ردود الطلبات، والتعديلات، والإلغاءات، واتفاقيات الطلبات، والكتالوجات، وإشعارات الشحن. وتقوم خدمة Webhooks بإبلاغ نظامك بكل عملية تسليم.

تدفق الطلبات

أمر الشحن

الطلبات، والردود، والتغييرات، والإلغاءات

المواصفات

مواصفات Peppol BIS

الطلب فقط، عملية الطلب، الطلب المسبق، اتفاقية الطلب

الأحداث

الويب هوكس الموقعة

تم الاستلام، تم التسليم، تأخر التسليم، وفشل التسليم

التوافر

99.8% شهريًّا

تعاقدي، مع أرصدة خدمة

مسار طلبات Peppol في واجهة برمجة تطبيقات واحدة

يتصل كل من المشتري والمورد عبر نقطة الوصول الخاصة به. يقوم نظامك بإرسال واستلام الرسائل عبر واجهة برمجة تطبيقات (API) الخاصة بـ Qvalia، بينما تتولى Qvalia مهام التحقق من صحة البيانات والبحث عن المستلم والتسليم عبر شبكة Peppol.

مسار عملية الطلب عبر Peppol بين المشتري والمورد من خلال Qvaliaيرسل المورد كتالوجًا. ويرسل المشتري طلبًا، فيرد المورد برد على الطلب. ويمكن للمشتري إرسال تعديل على الطلب، فيقوم المورد بتأكيده برد جديد على الطلب. ثم يرسل المورد إشعارًا بالشحن وفاتورة. وتمر كل رسالة عبر Qvalia، التي تتحقق من صحتها، وتبحث عن المستلم، وتسلمها عبر Peppol.المشترينظام المشتريات أو نظام تخطيط موارد المؤسسة (ERP)الموردنظام تخطيط موارد المؤسسة (ERP) أو إدارة الطلباتشبكة Peppolتقوم شركة «كفاليا» بالتحقق من صحة البيانات وتقديمهاالكتالوجBIS CatalogueالطلبBIS Orderingالرد على الطلبBIS Orderingتغيير الطلبBIS Advanced Orderingالرد على الطلبBIS Advanced Orderingإشعار الشحنBIS Despatch AdviceالفاتورةBIS BillingSpend Analytics 48المشترينظام المشتريات أو نظام تخطيط موارد المؤسسة (ERP)Spend Analytics 48الموردنظام تخطيط موارد المؤسسة (ERP) أو إدارة الطلبات
Peppol ordering flow between buyer and supplier through Qvaliaيرسل المورد كتالوجًا. ويرسل المشتري طلبًا، فيرد المورد برد على الطلب. ويمكن للمشتري إرسال تعديل على الطلب، فيقوم المورد بتأكيده برد جديد على الطلب. ثم يرسل المورد إشعارًا بالشحن وفاتورة. وتمر كل رسالة عبر Qvalia، التي تتحقق من صحتها، وتبحث عن المستلم، وتسلمها عبر Peppol.المشتريالموردQvaliaالكتالوجBIS CatalogueالطلبBIS Orderingالرد على الطلبBIS Orderingتغيير الطلبBIS Advanced Orderingالرد على الطلبBIS Advanced Orderingإشعار الشحنBIS Despatch AdviceالفاتورةBIS BillingSpend Analytics 48المشتريSpend Analytics 48المورد

استلام طلب والرد عليه

بصفتك موردًا، اشترك في خدمة «webhook» الخاصة بالوثائق الجديدة، واسترجع الطلبات غير المقروءة، ثم أرسل ردًا على الطلب. وبصفتك مشتريًا، أرسل الطلبات إلى نقطة النهاية الصادرة وتابع الردود على نقطة النهاية الواردة.

  • بيئة الاختبار على api-test.qvalia.com، والبيئة الإنتاجية على api.qvalia.com
  • JSON بشكل افتراضي، أو UBL XML مع رؤوس «Content-Type» و«Accept»
  • إن استخدام مفتاح «الإيدمبوتنسي» في كل طلب POST يجعل عمليات إعادة المحاولة آمنة

● ● ●

Sandbox: استرداد الطلبات غير المقروءة، ثم الرد عليها

# استرداد الطلبات الواردة غير المقروءة (ووضع علامة "مقروءة" عليها) curl “https://api-test.qvalia.com/transaction/$ACCOUNT_REG_NO/orders/incoming/readorders?limit=10” \ -H “Authorization: $QVALIA_API_KEY” \ -H “Accept: application/json” # الرد برد على الطلب curl -X POST \ “https://api-test.qvalia.com/transaction/$ACCOUNT_REG_NO/orderresponses/outgoing” \ -H “Authorization: $QVALIA_API_KEY” \ -H “Content-Type: application/json” \ -H “Idempotency-Key: $(uuidgen)” \ -d @order-response.json
# Fetch unread incoming orders (marks them as read)
curl "https://api-test.qvalia.com/transaction/$ACCOUNT_REG_NO/orders/incoming/readorders?limit=10" \
  -H "Authorization: $QVALIA_API_KEY" \
  -H "Accept: application/json"

# Reply with an order response
curl -X POST \
  "https://api-test.qvalia.com/transaction/$ACCOUNT_REG_NO/orderresponses/outgoing" \
  -H "Authorization: $QVALIA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d @order-response.json

ترتيب الرسائل ونقاط النهاية

كل مسار يبدأ بـ /transaction/{accountRegNo}. يحتوي كل نوع من أنواع الرسائل على نقاط نهاية للرسائل الصادرة والواردة، ونقطة نهاية للقراءة خاصة بالرسائل غير المقروءة، ونقطة نهاية للحالة.

رسالةأرسلهنقطة النهايةPeppol BIS
الطلبالمشتري/ordersالطلب فقط، عملية الطلب، الطلب المسبق
الرد على الطلبالمورد/orderresponsesالطلب، الطلب المتقدم
تغيير الطلبالمشتري/order-changesالطلبات المتقدمة
إلغاء الطلبالمشتري/order-cancellationsالطلبات المتقدمة
اتفاقية الطلبالمورد/orderagreementsاتفاقية الطلب
الكتالوجالمورد/cataloguesالكتالوج
الرد على الكتالوجالمشتري/catalogueresponsesكتالوج مع الردود
إشعار الشحنالمورد/despatch-advicesإشعار الشحن

تعتمد الرسائل التي يستخدمها حسابك على الخدمة والباقة. وتوجد مخططات الطلبات والاستجابات الخاصة بكل رسالة في مرجع واجهة برمجة التطبيقات (API) للطلبات. تمر فواتير الطلبات التي تم تسليمها عبر API الفوترة. للتحقق قبل الإرسال من أن المستلم مسجل في نوع الرسالة هذا، على سبيل المثال Order أو OrderResponse، استخدم البحث عن المستلم.

اختر نقطة انطلاقك

الموردون

إدارة الطلبات الإلكترونية

استقبل طلبات Peppol وأجب عليها من خلال تطبيق الويب الخاص بـ Qvalia، وقم بتحويلها إلى فواتير، قبل البدء في إنشاء عملية التكامل.

منصات المشتريات

Peppol المدمج

أرسل واستقبل الطلبات لعملائك. تقوم واجهة برمجة التطبيقات (API) الخاصة بالشركاء بإنشاء حساباتهم ومعرّفات Peppol الخاصة بهم، بينما تتولى واجهة برمجة التطبيقات (API) الخاصة بالطلبات نقل الرسائل.

التجارة الإلكترونية

Punchout

اربط الكتالوج الخاص بك بنظام المشتريات الخاص بالمشتري، بحيث يتم تحويل سلة التسوق إلى طلب شراء منظم.

الأسئلة الشائعة حول واجهة برمجة التطبيقات (API) للطلبات

ما هي واجهة برمجة التطبيقات (API) الخاصة بالطلبات؟

تتيح واجهة برمجة التطبيقات (API) الخاصة بالطلبات لنظامك إرسال واستلام أوامر الشراء، والرسائل المرتبطة بها، بتنسيق منظم. تنقل واجهة برمجة التطبيقات الخاصة بالطلبات من Qvalia رسائل Peppol BIS ordering بتنسيق JSON أو UBL XML، وتقوم بتسليمها عبر شبكة Peppol.

ما هي رسائل الترتيب التي تدعمها واجهة برمجة التطبيقات (API)؟

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

ما الفرق بين نظام Peppol « BIS Ordering » ونظام «Advanced Ordering»؟

يشمل موضوع «الطلب» عملية الطلب واستجابة الطلب. أما موضوع «الطلب المتقدم» فيشمل تعديلات الطلبات وإلغاءها، بحيث يمكن للمشتري تعديل الطلب أو إلغاؤه بعد إرساله. اقرأ «ما هو Peppol BIS Ordering ؟ » و«ما هو Peppol BIS Advanced Ordering ؟»

هل يمكنني استلام طلبات Peppol دون الحاجة إلى التكامل؟

نعم. تشمل جميع باقات «Connect» إمكانية استلام طلبات Peppol عبر تطبيق الويب الخاص بـ Qvalia. ويشمل ذلك الوصول إلى واجهة برمجة التطبيقات (API) وبيئة الاختبار (sandbox) بدءًا من باقة «Connect» Medium .

كيف أعرف أن الطلب قد تم تسليمه؟

اشترك في خدمة «webhooks» لتلقي إشعارات التسليم والأخطاء، أو اطلع على نقطة نهاية الحالة الخاصة بالطلبات. يمكن استرداد أي حدث تسليم مرة أخرى لمدة 30 يومًا باستخدام معرّف الحدث الخاص به.

هل يمكن أن يتحول الطلب إلى فاتورة؟

نعم. في تطبيق الويب «Connect»، تتوفر ميزة أتمتة عملية «من الطلب إلى الفاتورة» بدءًا من باقة « Medium ». أما في عملية التكامل الخاصة بك، فاستخدم بيانات الطلب لإنشاء الفاتورة وإرسالها عبر واجهة برمجة تطبيقات الفواتير (Invoicing API).

هل توجد منطقة تجارب؟

نعم. تستخدم بيئة الاختبار على api-test.qvalia.com مفتاح API خاص بها، لذا يمكنك اختبار إجراءات الطلبات دون التأثير على الطلبات الفعلية.

جميع خصائص المنصة