واجهة برمجة تطبيقات Market Dojo

واجهة برمجة تطبيقات Market Dojo

ما هي المشكلة التي تواجهها؟

أرغب في الاتصال بواجهة برمجة تطبيقات Market Dojo. كيف يمكنني فعل ذلك؟

حل

يمكن الوصول إلى Market Dojo برمجيًا باستخدام واجهة برمجة التطبيقات (API).

خطوات

  1. سجّل الدخول إلى ماركت دوجو

  2. انتقل إلى صفحة ملفك الشخصي، ودوّن بريدك الإلكتروني ومفتاح واجهة برمجة تطبيقات Market Dojo.

  3. انتقل إلى https://secure.marketdojo.com/api/v1/documentation  

  4. راجع نقاط النهاية المتاحة لفهم كيفية عمل واجهة برمجة التطبيقات (API).

  5. لاحظ أنه يمكنك تجربة واجهة برمجة التطبيقات (API) مباشرةً من صفحة التوثيق.

ما هي واجهات برمجة تطبيقات إعداد التقارير؟

يوفر Market Dojo عددًا من نقاط نهاية API المصممة للاستخدام مع أدوات إعداد التقارير مثل Power BI.

بالإضافة إلى نقاط النهاية المذكورة أدناه، يمكن الاطلاع على وثائق نقاط نهاية واجهة برمجة التطبيقات v1 على الرابط التالي: https://gl.marketdojo.com/api/v1/documentation

استخدام واجهات برمجة تطبيقات إعداد التقارير

يجب تقديم الطلبات إلى أحد الجهات التالية:

- https://secure.marketdojo.com، أو

- نطاق شركتك المُهيأ (على سبيل المثال، https://acme.marketdojo.com أو https://procurement.acme.com).


يتم حظر الطلبات التي تحتوي على رأس مضيف لأي نطاق آخر.


تأخذ واجهات برمجة التطبيقات الخاصة بالإبلاغ معيارين قياسيين:

البريد الإلكتروني : البريد الإلكتروني للمستخدم الذي يقوم بالوصول إلى نقطة النهاية

api_key : مفتاح API الخاص بالمستخدم (يمكن العثور عليه في صفحة ملفه الشخصي في تطبيق ماركت دوجو)


في حالة استخدام نقاط النهاية من سطر الأوامر، قد يكون من الضروري وضع عنوان URL بين علامتي اقتباس.


مثال

curl ' https://secure.marketdojo.com/api/v2/reports/contracts?email=email&api_key=api_key '


يتم إرجاع النتائج بتنسيق JSON.

أمور يجب التحقق منها

  • هل المستخدم عضو في المجموعة (الافتراضية)؟ إذا لم يكن كذلك، فسيتلقى خطأ 403.

الحصول على مفتاح API

يلزم وجود مفتاح API لاستخدام واجهة برمجة التطبيقات (API).

اتبع التعليمات هنا للحصول على مفتاح API الخاص بك.

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


نقاط نهاية واجهة برمجة تطبيقات التقارير المتاحة

شركات

https://secure.marketdojo.com/api/v2/reports/companies?email=email&api_key=key


ستعيد هذه النقطة النهائية معلومات حول شركة المستخدم.

المستخدمون

https://secure.marketdojo.com/api/v2/reports/users?email=email&api_key=key


ستعيد هذه النقطة النهائية معلومات حول جميع المستخدمين في الشركة.

العقود

https://secure.marketdojo.com/api/v2/reports/contracts?email=email&api_key=key



ستعيد هذه النقطة النهائية تفاصيل العقود التي يمكن للمستخدم الوصول إليها.

الفعاليات

https://secure.marketdojo.com/api/v2/reports/events?email=email&api_key=key


ستعيد هذه النقطة النهائية تفاصيل الأحداث التي يمكن للمستخدم الوصول إليها لعرضها.

استبيان

https://secure.marketdojo.com/api/v2/reports/questionnaires/:id?email=email&api_key=key


ستُعيد هذه النقطة النهائية تفاصيل الاستبيان، بما في ذلك الردود التي تم تلقيها.

ملاحظة: يجب استبدال :id برقم تعريف الاستبيان (رقم).

المشاركون في المحاكاة

https://secure.marketdojo.com/api/v2/reports/sim_participants?email=email&api_key=key


ستعيد هذه النقطة النهائية تفاصيل المشاركين في حدث إعداد الموردين.


SRM

https://secure.marketdojo.com/api/v2/reports/srm?email=email&api_key=key


ستُعيد هذه النقطة النهائية تفاصيل مجموعة إدارة علاقات الموردين (SRM) الخاصة بالمستخدم، بما في ذلك معلومات مثل حسابات srm، وجهات اتصال srm، والأنشطة والأحداث.