تخطَّ إلى المحتوى
Documentation

مرجع نقاط نهاية الخدمة

جميع المسارات الموجودة في هذه الصفحة مرتبطة بـ:

https://api.champrep.com

استخدم بيانات اعتماد حامل محددة النطاق كما هو موضح في المصادقة ومفاتيحAPI واجهة برمجة التطبيقات. لا يزال المسار المدرج خاضعًا لتوافر الخدمة الحالي، وإعدادات الخطة والمؤسسة، وأذونات الأدوار، والوصول إلى الموارد، وضوابط الاستخدام الفعلي.

المنطقةالبادئةالنطاقات
الهوية والملف الشخصي/v1/auth, /v1/usersusers:read وسياق بيانات الاعتماد
البحث عبر الخدمات/v1/searchنطاق القراءة لكل خدمة تم البحث عنها
Drive/v1/drivedrive:read, drive:write, drive:delete
Chat/v1/chatchat:read, chat:write
Calendar/v1/calendarcalendar:read, calendar:write
Contacts/v1/contactscontacts:read, contacts:write
Meet/v1/meetmeet:read, meet:write
Notes/v1/notesnotes:read, notes:write
جداول البيانات/v1/sheetssheets:read, sheets:write, sheets:share, sheets:delete, sheets:export
المستندات/passthrough/docsdocs:read, docs:write, docs:share, docs:delete, docs:export
Learn/v1/learn, /v1/coursescourses:read, courses:write
CHAMPREP AI/v1/aiai:chat
Mail/v1/mailmail:read, mail:write, mail:send
Work/v1/workwork:read, work:write, work:delete
Org Chart/v1/chartscharts:read, charts:write, charts:delete
Forms/v1/formsforms:read, forms:write
Invoice/v1/invoiceinvoice:read, invoice:write, invoice:send, invoice:delete
CHAMPREP QA/v1/qaqa:read, qa:write
CHAMPREP Code/passthrough/codecode: النطاقات، انظر CHAMPREP Code
مزرعة Runner/passthrough/runner-farmrunner_farm:read, runner_farm:write
CHAMPREP Business/v1/businessbusiness:read, business:manage
الفوترة/v1/billingbilling:read, billing:manage
Webhooks/v1/webhookswebhooks:manage

GET, HEAD، و OPTIONS تتطلب عادةً نطاق القراءة. تتطلب طرق الإنشاء والتحديث والإجراءات نطاق الكتابة أو الإدارة. تتطلب طرق الحذف نطاق الحذف حيثما تحدده الخدمة. قد يتطلب المسار أذونات إضافية للدور أو المورد في الخدمة الوجهة.

طريقةالمسارالغرض
GET/v1/versionإرجاع معلومات إصدار بوابة الوصول العامة.
GET/v1/auth/whoamiإرجاع سياق المستخدم النشط والملف الشخصي وبيانات الاعتماد والخطة.
GET/v1/auth/quotaإرجاع المفتاح الحالي ولقطة لحصة البوابة.
GET/v1/users/meإرجاع ملف تعريف المستخدم الحالي.
GET/v1/users/me/notificationsسرد الإشعارات المرئية للمستخدم الحالي.

كما يستخدم التبادلCLI المدعوم بالمتصفح /v1/auth/cli/start, /v1/auth/cli/device، و /v1/auth/cli/poll. يتم تنفيذ هذه المسارات بواسطة التطبيق CLIالرسمي؛ ولا ينبغي للتطبيقات المخصصة محاكاة بروتوكول الموافقةCLI عندما يلبي مفتاحAPI ما احتياجاتها.

طريقةالمسارالنطاقالغرض
GET/v1/searchلكل خدمة، انظر أدناهابحث في كل خدمة يمكن لهذه البيانات التعريفية الوصول إليها، في استدعاء واحد.
GET/v1/search/servicesلا شيءاذكر الخدمات التي يمكن لهذه البيانات التعريفية البحث فيها.

/v1/search يتفرع إلى الخدمات التي تدعم البحث ويدمج النتائج. المعلمات:

المعلمةالافتراضيالغرض
qمطلوبمصطلح البحث.
limit5الحد الأقصى للنتائج لكل خدمة، يصل إلى 20.
servicesالكلقائمة مفصولة بفواصل، على سبيل المثال mail,drive. يضيق نطاق الانتشار.
semanticfalseتعيين true لإعادة ترتيب النتائج باستخدام الذكاء الاصطناعي والحصول على إجابة موجزة. يستهلك رصيد الذكاء الاصطناعي الخاص بك.

البحث الذكي باستخدام الذكاء الاصطناعي

Section titled “البحث الذكي باستخدام الذكاء الاصطناعي”

semantic=true تضيف «AI pass» إلى النتائج التي لديك بالفعل: فهي تقرأ سؤالك، وتعيد ترتيب النتائج المطابقة حسب مدى ملاءمتها للإجابة، وتضيف سببًا موجزًا لكل نتيجة، وتعرض فقرة واحدة answer.

يتم دفع تكلفة هذه الخدمة من رصيد الذكاء الاصطناعي الخاص بك — وهو نفس الرصيد الشهري الذي CHAMPREP AIيستخدمه المساعد. لا يتم تحصيل أي رسوم ما لم تطلب ذلك، و البحث باستخدام الكلمات المفتاحية لا يكلف أبدًا رصيد الذكاء الاصطناعي.

توضح كل استجابة ما حدث في semantic:

"semantic": { "requested": true, "applied": true, "answer": "..." }

عندما يتعذر تشغيل «AI pass»، يتم عرض نتائج الكلمات المفتاحية دون تغيير و semantic يشرح السبب:

reasonالمعنى
AI_CREDITS_EXHAUSTEDلقد استنفدت رصيدك الشهري لخدمة الذكاء الاصطناعي.
PLAN_NO_AIلا تشمل خطتك خدمة الذكاء الاصطناعي.
AI_UNAVAILABLEتعذر الوصول إلى خدمة الذكاء الاصطناعي هذه المرة.

فشل «AI pass» لا يؤدي أبدًا إلى فشل عملية البحث. اتصل /v1/search/services أولاً لمعرفة ما إذا كان البحث الذكي قابلاً للاستخدام — فهو يعرض semantic.available بالإضافة إلى رصيدك المتبقي — وإخفاء خيار الذكاء الاصطناعي عندما لا يكون متاحًا.

لا يتم تضمين الخدمة إلا عندما تمتلك بيانات الاعتماد نطاق القراءة الخاص بها (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) و إذا كانت الخطة النشطة تسمح بذلك. يفشل كلا الاختبارين في حالة الإغلاق، لذا فإن الخدمة التي لا يمكنك استخدامها لا تساهم أبدًا في النتائج.

Chat يتم تشفير الرسائل أثناء تخزينها ولا يتم البحث فيها إلا داخل الغرف التي تنتمي إليها، عبر السجل الحديث بدلاً من الأرشيف الكامل.

Terminal window
curl -H "Authorization: Bearer $CHAMPREP_API_KEY" \
"https://api.champrep.com/v1/search?q=roadmap&services=mail,notes&limit=3"

يتم تجميع النتائج حسب الخدمة وتوحيدها في شكل واحد، بحيث يعرض العميل كل خدمة بنفس الطريقة:

{
"success": true,
"data": {
"query": "roadmap",
"groups": [
{
"service": "notes",
"label": "Notes",
"results": [
{ "id": "6650...", "title": "Q3 roadmap", "subtitle": "Planning notes for...", "timestamp": "2026-08-02T10:14:00Z" }
]
}
],
"totalResults": 1,
"searched": ["notes", "mail"],
"skipped": [{ "service": "drive", "reason": "INSUFFICIENT_SCOPE" }],
"cost": 2
}
}

اقرأ skipped قبل اعتبار النتيجة الفارغة على أنها «لم يتم العثور على شيء». كل إدخال يشرح سبب استبعاد الخدمة — INSUFFICIENT_SCOPE, NOT_IN_PLAN، أو SERVICE_UNAVAILABLE عندما تكون الخلفية بطيئة جدًّا أو غير قابلة للوصول لفترة وجيزة. لا تؤدي خدمة واحدة غير متوفرة أبدًا إلى فشل الاستعلام بأكمله؛ حيث لا تزال بقية النتائج تُعرض.

يصل البحث إلى خدمة واحدة لكل مجموعة نتائج، لذا يتم احتساب التكلفة على هذا النحو: وحدة حد معدل واحدة لكل خدمة تم البحث عنها فعليًا. الـ cost يخبرك الحقل الموجود في كل استجابة بالضبط بما تم احتسابه، و X-RateLimit-Remaining يعكس ذلك قبل أن تحصل على الرد.

الطلبالخدمات التي تم البحث عنهاالتكلفة
?q=roadmap في خطة تشمل الثماني خدمات جميعها88
?q=roadmap&services=mail11
?q=roadmap في خطة تضم فقط Notes11

لن يتم تحصيل أي رسوم منك مقابل خدمة لا يمكنك استخدامها، لذا فإن تضييق نطاق البحث باستخدام services هي الطريقة الأرخص للحفاظ على استجابة البحث التفاعلي. احرص دائمًا على إزالة التداخل — لا ترسل أبدًا طلبًا لكل ضغطة مفتاح.

طريقةالمسارالنطاقالغرض
GET/v1/drive/filesdrive:readسرد الملفات أو البحث عنها. استخدم search الاستعلام عند الحاجة.
GET/v1/drive/foldersdrive:readسرد محتويات المجلد الجذر.
GET/v1/drive/folders/{folderId}drive:readإدراج محتويات مجلد.
GET/v1/drive/starreddrive:readسرد العناصر المُعلَّمة بنجمة.
GET/v1/drive/recentdrive:readسرد العناصر الحديثة.
GET/v1/drive/shareddrive:readسرد العناصر المشتركة.
GET/v1/drive/quotadrive:readإرجاع استخدام مساحة التخزين الحالية والمساحة المتاحة.
POST/v1/drive/uploaddrive:writeإنشاء وجهة تحميل.
POST/v1/drive/filesdrive:writeحفظ بيانات تعريف الملف بعد نجاح عملية التحميل.
POST/v1/drive/downloaddrive:readقم بإنشاء رابط تنزيل قصير الأمد مرتبط ببيانات اعتماد المستدعي.
GET/v1/drive/content/{token}drive:readقم ببث رابط صادر عن /v1/drive/download.
POST/v1/drive/foldersdrive:writeإنشاء مجلد.
POST/v1/drive/renamedrive:writeنقل عنصر أو تغيير اسمه.
POST/v1/drive/deletedrive:deleteحذف عنصر واحد أو أكثر.
DELETE/v1/drive/files/{fileId}drive:deleteحذف ملف عبر المسار القديم الخاص بالعنصر الفردي.

تتطلب عمليات التنزيل خطوتين: POST /v1/drive/download تُرجع url على البوابة ويعمل فقط لمفتاحAPI أو الجلسة التي طلبته، حتى expiresInSeconds ينتهي. قم باسترداده باستخدام نفس Authorization الرأس؛ الرابط غير قابل للاستخدام بمفرده.

يُعد التحميل عملية متعددة الخطوات: طلب هدف للتحميل، ونقل البايتات إلى ذلك الهدف، وحفظ البيانات الوصفية الناتجة. استخدم CLIعندما لا تحتاج إلى تنفيذ تلك التسلسل بنفسك.

طريقةالمسارالنطاقالغرض
GET/v1/chat/roomschat:readسرد الغرف المرئية للملف الشخصي النشط.
GET/v1/chat/rooms/{roomId}chat:readقراءة غرفة واحدة.
POST/v1/chat/roomschat:writeإنشاء غرفة.
GET/v1/chat/rooms/{roomId}/messageschat:readسرد رسائل الغرفة.
POST/v1/chat/rooms/{roomId}/messageschat:writeإرسال رسالة إلى الغرفة.
GET/v1/chat/messages/searchchat:readالبحث عن الرسائل.
GET/v1/chat/unreadchat:readإرجاع عدد الرسائل غير المقروءة.
GET/v1/chat/favoriteschat:readسرد الرسائل المفضلة.
طريقةالمسارالنطاقالغرض
GET/v1/calendar/eventscalendar:readسرد الأحداث؛ يدعم startDate و endDate الاستعلامات.
GET/v1/calendar/events/{eventId}calendar:readقراءة حدث واحد.
POST/v1/calendar/eventscalendar:writeإنشاء حدث.
PATCH/v1/calendar/events/{eventId}calendar:writeتحديث حدث.
DELETE/v1/calendar/events/{eventId}calendar:writeحذف حدث.
GET/v1/calendar/upcomingcalendar:readسرد الاجتماعات القادمة.
GET/v1/calendar/invitationscalendar:readسرد الدعوات المعلقة.

إرسال الطوابع الزمنية للأحداث بتنسيق ISO 8601 مع منطقة زمنية محددة. يستهلك إنشاء الأحداث وتحديثاتها الحصة المحددة للخطة النشطة و المؤسسة؛ ولا APIيحدد حدًا ثابتًا عامًا للخطة.

طريقةالمسارالنطاقالغرض
GET/v1/contactscontacts:readعرض قائمة جهات الاتصال.
GET/v1/contacts/searchcontacts:readالبحث عن جهات الاتصال باستخدام q أو email.
GET/v1/contacts/favoritescontacts:readعرض قائمة المفضلة.
GET/v1/contacts/labelscontacts:readعرض قائمة بالتصنيفات.
GET/v1/contacts/{contactId}contacts:readقراءة جهة اتصال واحدة.
POST/v1/contactscontacts:writeإضافة جهة اتصال.
PUT/v1/contacts/{contactId}contacts:writeتحديث بيانات التعريف الخاصة بجهات الاتصال.
DELETE/v1/contacts/{contactId}contacts:writeحذف جهة اتصال.
طريقةالمسارالنطاقالغرض
GET/v1/meet/roomsmeet:readعرض قائمة بغرف الاجتماعات.
GET/v1/meet/rooms/{roomId}meet:readقراءة غرفة واحدة.
POST/v1/meet/roomsmeet:writeإنشاء غرفة.
GET/v1/meet/sessionsmeet:readسرد جلسات الاجتماعات.
GET/v1/meet/sessions/{sessionId}/participantsmeet:readعرض قائمة المشاركين في الجلسة.
GET/v1/meet/recordingsmeet:readعرض قائمة بالتسجيلات المتاحة.
GET/v1/meet/transcriptionsmeet:readعرض النصوص المكتوبة.
GET/v1/meet/transcriptions/{sessionId}meet:readقراءة نص محضر الجلسة النهائية.
GET/v1/meet/usagemeet:readإرجاع استخدام الاجتماع الحالي.

يعتمد الوصول إلى التسجيلات والنصوص على ملكية الاجتماع، والموافقة، والاحتفاظ، والخطة، وسياسة المؤسسة.

طريقةالمسارالنطاقالغرض
GET/v1/notesnotes:readعرض قائمة بالملاحظات.
GET/v1/notes/sharednotes:readعرض قائمة بالملاحظات التي تمت مشاركتها مع الملف الشخصي النشط.
GET/v1/notes/{noteId}notes:readقراءة ملاحظة واحدة.
POST/v1/notesnotes:writeإنشاء ملاحظة.
PATCH/v1/notes/{noteId}notes:writeتحديث ملاحظة.
DELETE/v1/notes/{noteId}notes:writeحذف ملاحظة.
POST/v1/notes/{noteId}/sharenotes:writeمشاركة ملاحظة باستخدام إعدادات الوصول المدعومة.

/v1/learn و /v1/courses عرض مسارات الدورات التدريبية المختارة نفسها.

طريقةالمسارالنطاقالغرض
GET/v1/learncourses:readعرض قائمة بالدورات التدريبية المتاحة.
GET/v1/learn/enrolled/mycourses:readعرض قائمة بالتسجيلات الحالية للمستخدم النشط.
GET/v1/learn/{courseId}courses:readقراءة دورة تدريبية واحدة.
GET/v1/learn/{courseId}/sectionscourses:readعرض أقسام المقرر الدراسي.
POST/v1/learncourses:writeإنشاء دورة تدريبية عندما يسمح الدور بذلك.
PUT/v1/learn/{courseId}courses:writeتحديث دورة تدريبية عندما يسمح الدور بذلك.

استخدام /v1/courses البادئة بدلاً من ذلك عند صيانة تكامل يستخدم هذا الاسم المستعار بالفعل.

طريقةالمسارالنطاقالغرض
POST/v1/ai/chatai:chatإرسال موجه أو حمولة محادثة مدعومة.
GET/v1/ai/conversationsai:chatعرض قائمة بالمحادثات المحفوظة.
GET/v1/ai/conversations/{conversationId}ai:chatقراءة محادثة واحدة.
DELETE/v1/ai/conversations/{conversationId}ai:chatحذف محادثة.
GET/v1/ai/usageai:chatإرجاع الاستخدام الحالي للذكاء الاصطناعي.

قد تكون مخرجات الذكاء الاصطناعي غير مكتملة أو غير صحيحة. راجع المخرجات المهمة ولا ترسل بيانات لا يحق للمستخدم النشط الكشف عنها.

طريقةالمسارالنطاقالغرض
GET/v1/mail/accountsmail:readسرد حسابات البريد المرتبطة.
GET/v1/mail/emailsmail:readسرد الرسائل.
GET/v1/mail/emails/{emailId}mail:readقراءة رسالة واحدة.
GET/v1/mail/threadsmail:readسرد سلاسل المحادثات.
GET/v1/mail/threads/{threadId}mail:readقراءة سلسلة محادثة واحدة.
POST/v1/mail/sendmail:sendإرسال رسالة.
GET/v1/mail/domainsmail:readعرض قائمة بمجالات البريد المرئية.

تعكس واجهة Work«البوابة» الإصدارات المدعومة الموجودة أسفلWorkAPI /v1/work. تحدد البوابة النطاق المطلوب من طريقة HTTP:

  • تتطلب طرق القراءة work:read.
  • تتطلب طرق الإنشاء والتحديث work:write.
  • تتطلب طرق الحذف والإجراءات الجماعية المدمرة أو إجراءات إلغاء الاستيراد work:delete.

تشمل المسارات الشائعة ما يلي:

طريقةالمسارالغرض
GET, POST/v1/work/boardsسرد اللوحات أو إنشاؤها.
GET, PUT, DELETE/v1/work/boards/{boardId}قراءة لوحة أو تحديثها أو أرشفتها.
GET/v1/work/boards/{boardId}/kanbanقراءة عرض «كانبان» للوحة.
GET/v1/work/boards/{boardId}/export/csvتصدير لوحة بتنسيق CSV.
GET/v1/work/boards/{boardId}/export/jsonتصدير لقطة منظمة للوحة.
GET, POST/v1/work/ticketsالبحث عن التذاكر أو إنشاؤها.
GET, PUT, DELETE/v1/work/tickets/{ticketId}قراءة تذكرة أو تحديثها أو أرشفتها.
GET/v1/work/me/dashboardإرجاع ملخص Workلوحة معلومات «العمل» النشطة.
GET/v1/work/me/quotaإرجاع Workالاستخدام والحدود الحالية لـ .
GET, POST/v1/work/import/jobsسرد مهام الاستيراد المدعومة أو إدارتها.

لا تزال اللوحات، والتذاكر، والسباقات، وعمليات الأتمتة، وعمليات الاستيراد، وسجلات الوقت، والتعليقات، والمرفقات، وطرق العرض المحفوظة، وعضوية مساحة العمل تفرضWork أدوارها وأذونات الموارد الخاصة بها بعد فحص نطاق البوابة.

Org Chartتتوفر واجهة أسفل /v1/charts. تتطلب طرق القراءة charts:read، تتطلب طرق الإنشاء والتحديث charts:write، وطرق الحذف تتطلب charts:delete.

تشمل المسارات الشائعة ما يلي:

طريقةالمسارالغرض
GET/v1/charts/me/org-chartاقرأ مخطط المستخدم النشط.
GET/v1/charts/me/positionقراءة موضع المخطط النشط.
GET/v1/charts/me/connectionsقراءة اتصالات العلاقات.
GET/v1/charts/me/suggestionsاقرأ اقتراحات العلاقات.
GET/v1/charts/users/searchابحث عن المستخدمين لعلاقات المخطط.
GET/v1/charts/orgs/{orgId}/chartقراءة مخطط هيكلي للمؤسسة.
PATCH/v1/charts/orgs/{orgId}/configتحديث تكوين المخطط.
POST/v1/charts/orgs/{orgId}/chart/nodesإنشاء عقدة مخطط.
PATCH, DELETE/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}تحديث أو حذف عقدة.

كما تعرض البوابة (Gateway) بادئات الخدمات ذات الإصدارات التالية:

البادئةنطاق القراءةنطاق الكتابة أو الإجراءاتنطاق الحذف
/v1/formsforms:readforms:write—
/v1/sheetssheets:read؛ تستخدم إجراءات التصدير sheets:exportsheets:write؛ يستخدم المشاركة والنشر sheets:sharesheets:delete
/v1/invoiceinvoice:readinvoice:write؛ تستخدم إجراءات الإرسال أو الإصدار invoice:sendinvoice:delete
/v1/qaqa:readqa:write—
/v1/businessbusiness:readbusiness:manage—
/v1/billingbilling:readbilling:manage—

تحافظ هذه البادئات على لاحقة المورد المدعومة أسفل البوابة مع تركيز المصادقة، والوصول إلى الخدمة، والنطاقات، وحدود المعدل، وسياق التدقيق . يُفضل استخدام مسار تظهره الخدمة صراحةً بدلاً من تخمين مسارات الموارد من حركة مرور المتصفح.

الفوترة هي واجهة مستوى التحكم. وتظل خاضعة لـ API Gatewayالوصول، وحدود المعدل، ونطاقات الفوترة حتى عندما تمنع بوابة خدمة الوجهة المستخدم من سداد الدفعة أو الترقية.

CHAMPREP يتم الوصول إلى Code و«مزرعة المشغلات» وDocs من خلال ممر: تقوم البوابة بإعادة توجيه طلبك إلى REST الخاص بتلك الخدمة APIتحت مسار ثابت ، بعد إجراء نفس عمليات التحقق من المفتاح، وحدود المعدل، والخطة، والنطاق كما هو الحال مع كل مسار آخر. المسار الذي يلي البادئة هو المسارAPI الخاص بالخدمة .

البادئةإعادة التوجيهمثال
/passthrough/codeCHAMPREP مساراتAPI «Code» الموجودة ضمن /v1/codeGET /passthrough/code/v1/code/projects
/passthrough/runner-farmAPIمسارات مزرعة Runner تحت /v1GET /passthrough/runner-farm/v1/pools
/passthrough/docsAPIمسارات المستندات تحت /api/v1/docsGET /passthrough/docs/api/v1/docs/documents

المسار خارج مساحة الأسماء المسموح بها يُرجع 404 NOT_FOUND. فقط بيانات اعتماد البوابة نفسها هي التي تصل إلى الخدمة: لا ترسل رموز الخدمة في رؤوس الرسائل أو في job_token, private_token، أو access_token معلمات الاستعلام ، لأن البوابة (Gateway) تقوم بإزالتها.

  • GET, HEAD، و OPTIONS تحتاج إلى واحد على الأقل code: نطاق يمكنه القراءة. تحتاج الطرق الأخرى إلى code:api أو code:write_ النطاق.
  • CHAMPREP ثم يتحقق «Code» من النطاق الدقيق لكل نقطة نهاية، بنفس الطريقة التي يتحقق بها من رمز الوصول الشخصي. على سبيل المثال، تتطلب قراءة ملفات المستودع code:read_repository, code:read_api، أو code:api.
  • المسارات الموجودة ضمن /v1/code/admin تحتاج إلى مفتاح يحتوي على code:admin_mode حسب الاسم، وحسابًا يكون مسؤولًا عن Code. لا تعمل أحرف البدل و code:api لا تصل إليها.

  • تحتاج طرق القراءة إلى runner_farm:read. تحتاج الطرق الأخرى إلى runner_farm:write.
  • لا يصل المفتاح أبدًا إلى أسرار الموصل، أو رموز Runner، أو فحص الرمز، أو الاقتران، أو نقاط النهاية الخاصة بالموصل، كما أنه لا يشتري أبدًا أرصدة أو يغير إعدادات الدفع. استخدم تطبيق مزرعة Runner، بعد تسجيل الدخول، لهذه الأغراض.

الطلبالنطاق
GET, HEADdocs:read
مسار يدير التراخيص أو روابط المشاركة أو النشرdocs:share
DELETE، أو مسار ينتهي بـ /purgedocs:delete
مسار ينتهي بـ /exportdocs:export
أي تغيير آخرdocs:write

يُعد حذف صورة داخل مستند عملية تحرير عادية ويتطلب docs:write.

تستخدم إدارة Webhook /v1/webhooks و webhooks:manage. راجع الدليل المخصص لـ دليل webhook لتسجيل نقاط النهاية، والتحقق من التسليم الموقّع ، والحماية من إعادة التشغيل، وتناوب الأسرار.

الحفاظ على تحديث عمليات التكامل

Section titled “الحفاظ على تحديث عمليات التكامل”
  • استخدم GET /v1/version للحصول على معلومات إصدار البوابة.
  • تجاهل حقول الاستجابة الإضافية التي لا يفهمها عميلك.
  • اقرأ رؤوس الحدود الحية بدلاً من الترميز الثابت لقيم الخطط.
  • استخدم نطاق «أقل الامتيازات» المحدد.
  • اتبع ملاحظات الإصدار الموجودة على موقع الوثائق عند اعتماد مسار جديد.