قبل أن يقوم نظام تخطيط موارد المؤسسة (ERP) أو منصتك بإرسال فاتورة أو طلب شراء أو أي مستند Peppol آخر، يمكنه الاستعلام من Qvalia عما إذا كان عنوان « Peppol ID » الخاص بالمستلم مسجلاً أم لا، وعن أنواع المستندات التي يمكن للمستلم استلامها. فالمستند الذي يُرسل إلى مشارك غير مسجل لاستلامه يتم رفضه من قبل الشبكة؛ لذا فإن هذا الفحص يتيح لنظامك اكتشاف أي عنوان « Peppol ID » مفقود أو خاطئ قبل إرسال أي شيء.
# Account API
GET /account/{accountRegNo}/action/lookup/peppol/{peppolId}
# Partner API
GET /partner/{partnerRegNo}/peppol/lookup/{peppolId}
| واجهة برمجة تطبيقات الحساب | واجهة برمجة التطبيقات للشركاء | |
| يستخدمه | الشركات التي ترسل من حساب «كفاليا» الخاص بها | المنصات ومقدمو الخدمات الذين يقومون بالإرسال نيابة عن عملائهم |
| مرشح اختياري | docTypeRoot، على سبيل المثال Invoice أو CreditNote | docTypeRoot، على سبيل المثال Invoice, OrderResponse أو MLR |
| عناوين URL الأساسية | صندوق الرمل api-test.qvalia.com، الإنتاج api.qvalia.com | صندوق الرمل api-test.qvalia.com، الإنتاج api.qvalia.com |
متى يجب التحقق من هوية المستلم
- عند إنشاء عميل في نظامك، أو عند تغيير عنوانه البريدي ( Peppol ID )
- عندما يقوم المستخدم بكتابة عنوان Peppol ID يدويًّا
- قبل إرسال مستند من نوع لم يسبق للمستلم أن تلقى مثله منك من قبل، مثل الرد على الطلب الأول أو إشعار الائتمان
تقديم الطلب
- اكتب عنوان Peppol ID على شكل مخطط ومعرّف مفصولين بفاصلة، على سبيل المثال
0007:1234567890للحصول على رقم تسجيل المنظمة السويدية. - أرسل طلب GET إلى نقطة نهاية البحث، مع إدراج مفتاح API الخاص بك أو JWT في
Authorizationالعنوان. - إضافة
docTypeRootإذا كنت تريد الإجابة الخاصة بنوع مستند واحد، يُشار إليه باسم عنصره الجذري في لغة UBL.
GET /account/{accountRegNo}/action/lookup/peppol/0007:1234567890
?docTypeRoot=Invoice
Host: api-test.qvalia.com
Authorization: <your API key>
اقرأ الرد
| الحالة | المعنى | ماذا تفعل |
| 200 | المشارك المسجل في Peppol، مع أنواع المستندات التي يمكنه استلامها | أرسل إذا كان نوع المستند الذي تحتاجه مدرجًا في القائمة |
| 422 | موقع « Peppol ID » غير متوفر حالياً scheme:identifier | قم بتصحيح التنسيق، على سبيل المثال 0007:1234567890 |
| 429 | عدد الطلبات على حسابك كبير جدًّا | انتظر حتى Retry-After كما هو مذكور في العنوان، ثم أعد المحاولة |
تتضمن استجابة واجهة برمجة التطبيقات (API) الخاصة بالشريك أيضًا exists، والذي يوضح ما إذا كان عنوان Peppol ID مسجلاً أم لا، rootDocTypeExists، والذي يحدد ما إذا كان بإمكانه استقبال نوع المستند في docTypeRoot، وقائمة docTypes.
إذا لم يكن المستلم مسجلاً لهذا النوع من المستندات، فاطلب منه تقديم عنوان البريد الإلكتروني الصحيح ( Peppol ID)، أو اتفق معه على طريقة أخرى لتسليم المستند.
التحقق من مستلم واحد يدويًّا
للتحقق من شركة واحدة دون استخدام ميزة التكامل، استخدم البحث عبرPeppol ID .
مواضيع ذات صلة: Peppol SMP و SML · ما هو « Peppol ID »؟ · واجهة برمجة تطبيقات الفواتير · مرجع واجهة برمجة التطبيقات