للمطوّرين

توثيق Kringl

كل ما تحتاجونه لربط نظام آخر بأعضاء Kringl: افتحوا محادثة من الكود الخاص بكم، سلّموا مارك مهمة واستلموا النتيجة، واعرفوا بكل انتهاء عبر webhook.

آخر تحديث:

في هذه الصفحة
  1. 1ما الموجود هنا
  2. 2البداية
  3. 3أين يوجد كل شيء

باختصار

  • الـ API العام موجود على https://web.kringl.ai/api/v1 ويتحدث JSON. النقاط والمعاملات والأخطاء في صفحة مرجع الـ API (بالإنجليزية).
  • يُنشأ المفتاح في البوابة، في شاشة مفاتيح API في حسابكم. يظهر مرة واحدة فقط ويخص عضوًا واحدًا في الفريق.
  • ما يفعله أعضاء Kringl عبر الـ API هو بالضبط ما يفعلونه في المحادثة: المحادثة نفسها، الرصيد نفسه، وطلب الدمج نفسه.

ما الموجود هنا

Kringl هو فريق من أعضاء Kringl، شخصيات لكل منها اسم ودور، تقوم بعمل البرمجيات: مارك يكتب الكود، بابلو يصمّم، وستيف ينشر في متاجر التطبيقات. في معظم الوقت تعملون معهم في المحادثة، في التطبيق على web.kringl.ai.

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

  • مرجع الـ API (بالإنجليزية): المفاتيح والصلاحيات، الأعراف، حدود الطلبات، الجلسات والتشغيلات، webhooks، ومثال كامل من البداية إلى النهاية.
  • الأتمتة: كيف تولد المهمة من نموذج أو بريد إلكتروني أو واتساب أو لوحة TODO، بلا كود إطلاقًا.
  • السوق: الخدمات التي يربطها Kringl بالمواقع والتطبيقات.

البداية

  • سجّلوا الدخول إلى البوابة على web.kringl.ai بمستخدمكم.
  • في شاشة مفاتيح API اضغطوا على مفتاح جديد، سمّوه وانسخوه. يظهر مرة واحدة فقط.
  • أرسلوا أول طلب: GET /api/v1/me مع المفتاح في ترويسة Authorization: Bearer. الرد يقول من أنتم وفي أي استوديو.
  • تابعوا إلى الجلسات والتشغيلات.
curl
curl https://web.kringl.ai/api/v1/me \
  -H "Authorization: Bearer wzk_your_key_here"

المفتاح هو كلمة مرور. احفظوه في خزنة أو في بيئة الخادم الخاص بكم، وليس في الكود، وليس في commit، وليس في متصفح المستخدم.

اقرؤوا مرجع الـ API (بالإنجليزية)

أين يوجد كل شيء

عناوين Kringl
ماذاأين
التطبيقweb.kringl.ai
الـ APIhttps://web.kringl.ai/api/v1
مفاتيح APIweb.kringl.ai/account/apikeys
التوثيقkringl.ai/docs
الشروط والخصوصيةشروط الاستخدام (بالإنجليزية), سياسة الخصوصية (بالإنجليزية)

ينقصكم شيء في التوثيق؟ اكتبوا لنا بالبريد الإلكتروني، بالعبرية أو بالإنجليزية، ويردّ عليكم شخص من الفريق.