تخط وانتقل إلى المحتوى الرئيسي

تطبيقات المطوّرين ومفاتيح API وWebhooks

أنشئ التطبيقات ومفاتيح API، واختبر في بيئة اختبار، وأرسل Webhooks، وثبّت تطبيقات الشركات الأخرى، وراجع سجلات الطلبات والإنفاق حسب المفتاح.

بقلم: Sarah Chen

إعدادات المطوّر هي المكان الذي تربط فيه Exayard بأكوادك الخاصة وبالتطبيقات التي تبنيها شركات أخرى. افتح الإعدادات ثم المطوّر. لا يرى هذا الخيار في قائمة الإعدادات إلا مسؤولو الشركة. ويمكن للعضو الذي يفتح الصفحة قراءتها دون تغيير أي شيء فيها.

تتوفر التطبيقات ومفاتيح API وWebhooks والسجلات في كل الخطط، بما فيها الخطة المجانية. ولا تُحتسب تكلفة إلا على أعمال الذكاء الاصطناعي.

التطبيقات

التطبيق هو أحد تكاملاتك، مثل "Acme estimator" أو "Nightly sync". ينتمي كل مفتاح API إلى تطبيق. وقسم التطبيقات هو القسم الأول في الصفحة. يمكن لكل عضو قراءته، لكن المسؤولين وحدهم ينشئون التطبيقات أو يغيّرونها.

انقر على تطبيق جديد واملأ الاسم والوصف والصفحة الرئيسية والبريد الإلكتروني للدعم والنطاقات. تنقسم النطاقات إلى قراءة وكتابة لكل مورد، مثل read:projects وwrite:estimates. لا يمكن للتطبيقات طلب النطاق admin:org. ويمكن للشركة امتلاك 25 تطبيقًا كحد أقصى.

يعرض كل تطبيق تاريخ إنشائه وحد معدل الطلبات الخاص به، مثل "حتى 60 طلبًا في الدقيقة لكل شركة و600 طلب إجمالًا". وتضم قائمة مزيد من الإجراءات الخاصة بالتطبيق ما يلي:

  • تعديل: يغيّر تفاصيل التطبيق ونطاقاته.

  • Webhook: يضبط العنوان الوحيد الذي يستقبل الأحداث من كل شركة ثبّتت التطبيق.

  • حذف التطبيق: يزيل التطبيق ويُبطل كل مفاتيحه. وتفقد كل شركة ثبّتته صلاحية الوصول.

مفاتيح API

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

لإنشاء مفتاح، انقر على مفتاح جديد في التطبيق. امنح المفتاح الاسم، مثل "Production". ضمن النطاقات، اختر الكل لمنح كل نطاقات التطبيق، أو محدد لاختيار عدد أقل منها. اضبط تاريخ ينتهي في اختياريًا إذا كان المفتاح لعمل قصير الأمد. يظل المفتاح يعمل حتى نهاية ذلك اليوم. انقر على إنشاء.

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

يبدأ المفتاح بـ exa_live_. أما المفتاح الذي يُنشأ في بيئة اختبار فيبدأ بـ exa_test_. بعد إنشائه، يظهر المفتاح باسمه، ومعاينة مثل exa_live_...AbCd، وآخر استخدام أو لم يُستخدم بعد. ويعرض المفتاح الذي له تاريخ انتهاء ينتهي في مع تاريخه، ويعرض المفتاح المنتهي منتهي الصلاحية.

يمكن أن يكون للتطبيق 25 مفتاحًا نشطًا كحد أقصى. ويظل المفتاح المنتهي محتسبًا حتى تُبطله. لتبديل المفاتيح دون انقطاع، أنشئ مفتاحًا ثانيًا، وانقل خوادمك إليه، ثم أبطل الأول.

افتح قائمة إجراءات المفتاح الخاصة بمفتاح لتنفيذ إعادة التسمية أو إبطال. لا يمكن التراجع عن الإبطال، ويتوقف المفتاح عن العمل في غضون 30 ثانية.

إذا ظهر مفتاح في مكان عام، مثل مستودع أكواد عام، يُبطله Exayard، ويرسل بريدًا إلكترونيًا إلى مسؤولي شركتك، ويُبقيه في القائمة بعلامة عُثر عليه علنًا، تم إبطاله.

عندما تكون شركة أخرى قد ثبّتت تطبيقك، يعرض مربع حوار المفتاح الجديد أيضًا يعمل في. الخيار الافتراضي هو هذه الشركة. أما كل شركة ثبّتته فينشئ مفتاحًا يستخدمه خادمك في كل تلك الشركات. ويحدد كل استدعاء حينها شركته في الترويسة Exayard-Organization-Id.

تربط المفاتيح نفسها أدوات الأتمتة التي لا تتطلب برمجة. راجع ربط Exayard بـ Zapier، وربط Exayard بـ Make، وربط Exayard بـ n8n. ولمساعدي الذكاء الاصطناعي، راجع ربط Exa بمساعد الذكاء الاصطناعي لديك.

المفاتيح القديمة

تبدأ المفاتيح التي أُنشئت قبل أن تصبح المفاتيح جزءًا من التطبيقات بـ ak_. وهي تستمر في العمل، لكن لا يمكن إنشاء مفاتيح جديدة منها. تظهر ضمن المفاتيح القديمة أسفل الصفحة، ما دام بعضها موجودًا فقط.

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

بيئات الاختبار

بيئة الاختبار شركة تجريبية مرتبطة بشركتك. استخدمها لبناء تكامل واختباره دون المساس بمشاريعك الحقيقية. لا يرى بيئات الاختبار إلا المسؤولون.

انقر على بيئة اختبار جديدة، وامنحها الاسم، ثم انقر على إنشاء. يمكن للشركة امتلاك 5 بيئات اختبار كحد أقصى. ينقلك فتح إلى بيئة الاختبار، حيث يميّزها مبدّل الشركات بعلامة بيئة اختبار. أنشئ تطبيقًا ومفتاحًا هناك كالمعتاد. تبدأ مفاتيحها بـ exa_test_. وللانتقال إلى التشغيل الفعلي، أنشئ التطبيق والمفتاح نفسيهما في شركتك الحقيقية واستبدل المفتاح في أكوادك.

تتبع بيئة الاختبار خطة شركتك، وتدفع شركتك تكلفة استخدامها. ليس لها فوترة خاصة بها، ولا تحصل على استخدام شهري خاص بها للذكاء الاصطناعي. وتعمل Webhooks والتكاملات فيها كما تعمل في شركتك الحقيقية.

لا ترسل بيئة الاختبار رسائل البريد الإلكتروني لمشاركة العروض أو النسخ الموقّعة إلى أشخاص من خارجها، ولا ترسل أي رسائل نصية. وتظهر هذه الرسائل بعبارة "لم يُرسل لأن هذه الشركة بيئة اختبار". أما الدعوات للانضمام إلى بيئة الاختبار فتُرسل كالمعتاد.

تُرجع عمليات حصر الكميات وقراءة الملفات في بيئة الاختبار نتائج منسوخة من مشروعنا النموذجي، بلا تكلفة. ويُميَّز حصر الكميات وصفحاته وWebhook الخاص باكتماله بأنها نماذج. وتجيب تقديرات التكلفة والعطاءات والبحث عن العناصر والمحادثة بنماذج أيضًا، بلا تكلفة.

لإزالة بيئة اختبار، انقر على حذف في صفها، ثم حذف بيئة الاختبار. تُغلق بيئة الاختبار، وتتوقف مفاتيحها عن العمل، وتُمحى بياناتها لاحقًا.

Webhooks

يطلب Webhook من Exayard إشعار خادمك عند وقوع حدث ما في شركتك. يمكن لكل عضو قراءة القائمة، لكن المسؤولين وحدهم يضيفون Webhooks أو يغيّرونها.

انقر على إنشاء Webhook، وأدخل URL الذي يجب أن يستقبل عمليات التسليم، وأضف الوصف إن أردت. اختر الأحداث التي تريد إرسالها. حدد الكل لتلقي كل الأحداث، بما فيها الجديدة، أو محدد للاختيار من القائمة. كل حدث ومحتوياته مدرجة في دليل أحداث Webhook.

عند إنشاء Webhook، يعرض Exayard سر التوقيع الخاص به مرة واحدة. انسخه حينها، لأنه لن يُعرض مرة أخرى.

افتح قائمة مزيد من الإجراءات الخاصة بـ Webhook لبقية الخيارات:

  • تعديل: يغيّر عنوان URL والوصف والأحداث، ويضبط الحالة على نشط أو متوقف مؤقتًا. لا يتلقى Webhook المتوقف مؤقتًا أي عمليات تسليم. ويحتوي مربع الحوار أيضًا على تدوير السر. يتوقف السر القديم عن العمل فورًا، لذا حدّث خادمك أولًا.

  • إرسال حدث تجريبي: يرسل حدثًا واحدًا من نوع الحدث الذي تختاره. ينتظر مربع الحوار رد خادمك ويعرض النتيجة ورمز الاستجابة. ويحمل الحدث التجريبي "test": true.

  • عمليات التسليم: يسرد آخر 25 عملية تسليم مع حدثها وحالتها ورمز الاستجابة وعدد المحاولات. وتكون عملية التسليم قيد الانتظار أو جارٍ إعادة المحاولة أو تم التسليم أو فشل. ويمكن للمسؤولين النقر على إعادة الإرسال لإرسال عملية تسليم مجددًا.

  • حذف Webhook: يُنهي كل عمليات التسليم إلى ذلك العنوان.

يُرسل الحدث التجريبي وإعادة الإرسال مرة واحدة ولا تُعاد محاولتهما أبدًا.

تأمين عمليات تسليم Webhook

تحمل كل عملية تسليم ترويسة Exayard-Signature بالصيغة t=<unix>,v1=<digest>. ينشئ Exayard التوقيع بدمج الطابع الزمني مع نص الطلب، ثم توقيعهما باستخدام HMAC-SHA256 بسر Webhook الخاص بك.

تحمل كل عملية تسليم أيضًا الترويسات Exayard-Event-Id وExayard-Event-Type وExayard-Organization-Id. ويحتوي نص JSON على الحقل organizationId الذي يحدد الشركة التي صدر عنها الحدث. وتحمل الترويسة المُعرّف نفسه، بحيث يمكنك توجيه عملية التسليم قبل قراءة النص. ويشمل التوقيع النص بالكامل، بما في ذلك organizationId.

نظرًا لأن كل عملية تسليم تحدد شركتها، يمكن لعنوان استقبال واحد أن يخدم شركات متعددة. سجّل عنوان URL نفسه في كل شركة، ووجّه كل عملية تسليم حسب organizationId. لكل Webhook سره الخاص، لذا اختر السر حسب Exayard-Organization-Id قبل التحقق.

للتحقق من عملية تسليم، أعد حساب التوقيع باستخدام سرك، وتأكد من أن الطابع الزمني يقع ضمن خمس دقائق من الوقت الحالي، ثم قارن الملخصات.

تُجرّب عملية التسليم الفاشلة حتى 10 مرات إجمالًا، على مدى 80 ساعة تقريبًا، مع فترات انتظار أطول بين المحاولات. وتُرسل كل محاولة النص نفسه ومعرّف الحدث نفسه. وتُحتسب إعادة التوجيه فشلًا.

السماح للشركات الأخرى بتثبيت تطبيقك

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

يفتح المسؤولون قائمة إجراءات التثبيت للخيارات التالية:

  • تعديل عناوين تسجيل الدخول: يضبط العناوين التي يعيد Exayard المستخدمين إليها عندما يسجّل تطبيقك دخولهم بحساباتهم في Exayard. أدخل عنوانًا واحدًا في كل سطر، حتى 10 عناوين. يجب أن يبدأ كل عنوان بـ https://، أو بـ http://localhost أثناء الاختبار. في أول مرة تحفظ فيها عناوين تسجيل الدخول، يعرض Exayard سر العميل الخاص بالتطبيق مرة واحدة.

  • نسخ رابط التثبيت: ينسخ رابطًا يمكنك إرساله إلى أي شركة. ويفتح مربع حوار التثبيت لمسؤول تلك الشركة.

  • طلب المراجعة: يرسل التطبيق إلى دعم Exayard لمراجعته.

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

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

Webhook التطبيق

افتح قائمة مزيد من الإجراءات الخاصة بالتطبيق وانقر على Webhook. أدخل URL وانقر على إنشاء، ثم انسخ سر التوقيع الذي يعرضه Exayard مرة واحدة فقط. ترسل كل شركة ثبّتت التطبيق الأحداث التي تغطيها النطاقات الممنوحة له. ويتلقى تطبيقك أيضًا app.installed وapp.scopes_approved وapp.uninstalled عندما تثبّته شركة، أو توافق على صلاحيات أوسع، أو تزيله. وتحدد عمليات التسليم شركتها وتُوقَّع بالطريقة نفسها المتبعة في Webhooks الأخرى.

يتيح لك مربع الحوار نفسه إيقاف مؤقت لعمليات التسليم واستئناف إرسالها، وتدوير السر، وحذف Webhook.

التطبيقات المتصلة

يسرد قسم التطبيقات المتصلة التطبيقات المثبّتة في شركتك. يمكن لكل عضو رؤيته، لكن المسؤولين وحدهم يثبّتون التطبيقات ويزيلونها ويوافقون عليها.

يعرض كل صف اسم التطبيق، وما إذا كان بحالة تمت مراجعته، والشركة التي بنته، ومن ثبّته ومتى، والنطاقات الممنوحة له.

تثبيت تطبيق

افتح رابط تثبيت التطبيق، أو انقر على تثبيت بجانبه في استكشاف التطبيقات. يعرض مربع الحوار من بنى التطبيق، وما إذا كان قد رُوجع، والنطاقات التي يطلبها. ثم اختر:

  • الشركة: أي شركة تكون فيها مسؤولًا. وتُميَّز الشركة التي لديها التطبيق بالفعل بعبارة (مثبّت). ويحفظ التثبيت مجددًا اختياراتك الجديدة.

  • المشاريع: كل المشاريع، أو هذه المشاريع فقط مع تحديد المشاريع التي يمكن للتطبيق الوصول إليها، حتى 500 مشروع. لا يمكن للتطبيق الوصول إلى أي مشروع آخر في الشركة.

  • الحد الشهري للذكاء الاصطناعي: أقصى ما يمكن أن تكلّفه أعمال الذكاء الاصطناعي للتطبيق شركتك في كل شهر فوترة، بعملة الفوترة لديك. اترك الحقل فارغًا لاختيار بلا حد.

انقر على تثبيت. إذا كان التطبيق يسجّل دخولك، ينقلك Exayard بعد ذلك لإكمال تسجيل الدخول إلى التطبيق. وإذا كنت عضوًا ولست مسؤولًا، يخبرك مربع الحوار بمسؤول الشركة الذي يمكنه تثبيته. انقر على نسخ الرابط لإرساله إليه.

لتغيير المشاريع لاحقًا، افتح رابط التثبيت مجددًا وثبّت التطبيق بالاختيار الجديد.

الموافقة على صلاحيات أوسع

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

إزالة تطبيق

افتح قائمة مزيد من الإجراءات الخاصة بالتطبيق، وانقر على إزالة، ثم أكّد. يفقد التطبيق صلاحية الوصول إلى شركتك فورًا وتتوقف Webhooks الخاصة به. أما أعمال الذكاء الاصطناعي التي بدأها بالفعل فتكتمل.

استكشاف التطبيقات

يظهر استكشاف التطبيقات داخل التطبيقات المتصلة. ويسرد التطبيقات التي تمت مراجعتها واختار مطوّروها إدراجها. ويظهر التطبيق الموجود لدى شركتك بالفعل بحالة مثبّت. انقر على تثبيت لأي تطبيق آخر لفتح مربع حوار التثبيت.

اتصالاتك الشخصية

يسرد قسم اتصالاتك الشخصية أدوات الذكاء الاصطناعي والتطبيقات الأخرى التي ربطتها بحسابك الشخصي في Exayard، مثل ChatGPT أو Claude. ويظهر في أعلى التطبيقات المتصلة، ولا يرى اتصالاتك أحد سواك. يعمل الاتصال الشخصي باسمك، لذا يمكنه الوصول إلى كل ما يمكنك الوصول إليه.

يعرض كل اتصال وقت أول استخدام وآخر استخدام له، والشركات التي استُخدم فيها. لإيقاف اتصال، افتح قائمة مزيد من الإجراءات الخاصة به، وانقر على إزالة، ثم أكّد. يُرفض استدعاؤه التالي. ويبقى الاتصال في القائمة بحالة تمت الإزالة، ويتيح السماح مجددًا إعادته. لربط أداة جديدة، راجع ربط Exa بمساعد الذكاء الاصطناعي لديك.

حسابات عملائك

يمكن لتطبيقك إنشاء شركات في Exayard عبر واجهة API للعملاء الذين يستخدمون Exayard من خلال منتجك فقط. تملك شركتك هذه الشركات وتدفع تكلفة أعمال الذكاء الاصطناعي التي تُنفَّذ فيها. لا يوجد فيها أعضاء خاصون بها، وتُثبَّت تطبيقاتك فيها تلقائيًا.

يسرد قسم حسابات عملائك هذه الشركات للمسؤولين، مع الاسم لكل شركة وتاريخ الإنشاء. انقر على التخلي ثم أكّد لإغلاق إحداها. يفقد كل تطبيق فيها صلاحية الوصول.

البدء

تحتوي بطاقة البدء السريع على موجّه جاهز لمحرر ذكاء اصطناعي مثل Claude أو Cursor. انقر على نسخ الموجّه والصقه في محررك. يتضمن الموجّه عنوان URL الأساسي لواجهة API، وصيغة المصادقة، والنطاقات، وآلية توقيع Webhooks، ليتمكن الذكاء الاصطناعي من بناء تكامل يعمل ويطلب منك التفاصيل التي يحتاجها. لا يرى هذه البطاقة إلا المسؤولون، لأنها تتطلب مفتاح API.

تحتوي بطاقة الوثائق على رابط إلى وثائق المطوّرين الكاملة عبر فتح الوثائق، وإلى مواصفات OpenAPI التي تصف كل مسار ومخطط. ويرى المسؤولون أيضًا الربط مع Claude أو Cursor، الذي يفتح إعدادات ربط مساعدي الذكاء الاصطناعي بـ Exayard.

السجلات

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

يرى المسؤولون كل الطلبات. ولا يرى الأعضاء إلا الطلبات التي لم تأتِ عبر تطبيق.

يمكن للمسؤولين التصفية حسب التطبيق، ثم حسب أحد مفاتيح ذلك التطبيق. ويمكن لأي شخص كتابة المستخدم النهائي لعرض طلبات ذلك العميل فقط. المستخدم النهائي هو المعرّف الذي تمنحه أنت لأحد عملائك. ويرسله أكوادك مع كل طلب في الترويسة Exayard-End-User. لا تستخدم أبدًا عنوان بريد إلكتروني معرّفًا.

حدد صفًا لعرض تفاصيله الكاملة، بما في ذلك معرّف الطلب، والتطبيق والمستخدم النهائي، ونص الطلب ونص الاستجابة. استخدم السجلات للتأكد من نجاح استدعاء ما أو لمعرفة سبب تعثر تكامل.

الإنفاق حسب المفتاح والمستخدم النهائي

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

الحد الشهري للذكاء الاصطناعي

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

عندما يبلغ التطبيق حده، تُرفض أعمال الذكاء الاصطناعي الخاصة به لبقية شهر الفوترة، حتى لو كان لدى شركتك استخدام متبقٍ للذكاء الاصطناعي. وتظل حدود شركتك الخاصة سارية. ولا تُحتسب أبدًا أعمال الذكاء الاصطناعي التي يبدؤها الأشخاص بأنفسهم ضمن حد التطبيق.

هل أجاب هذا عن سؤالك؟