למפתחים

התיעוד של Kringl

כל מה שצריך כדי לחבר מערכת אחרת לקרינגלים: לפתוח שיחה מהקוד שלכם, לתת למארק משימה ולקבל את התוצאה, ולשמוע על כל סיום דרך webhook.

עודכן לאחרונה:

בעמוד הזה
  1. 1מה יש כאן
  2. 2איך מתחילים
  3. 3איפה כל דבר גר

בקצרה

  • ה-API הציבורי יושב ב-https://web.kringl.ai/api/v1 ומדבר JSON. הכתובות, הפרמטרים והשגיאות בעמוד התיעוד של ה-API (באנגלית).
  • מפתח מנפיקים בפורטל, במסך מפתחות API שבחשבון שלכם. המפתח מוצג פעם אחת ושייך לחבר צוות אחד.
  • מה שהקרינגלים עושים דרך ה-API הוא בדיוק מה שהם עושים בצ'אט: אותה שיחה, אותו קרדיט, אותו PR.

מה יש כאן

Kringl הוא צוות של קרינגלים, דמויות עם שם ותפקיד שעושות עבודת תוכנה: מארק כותב קוד, פבלו מעצב, סטיב מפרסם בחנויות. בדרך כלל עובדים איתם בצ'אט, באפליקציה ב-web.kringl.ai.

התיעוד הזה הוא לרגע שבו הצ'אט לא מספיק: מערכת שלכם צריכה לפתוח שיחה בעצמה, לשלוח הודעה לשיחה קיימת, לעקוב אחרי הרצה ולקבל הודעה כשהיא נגמרה. לכל זה יש API אחד, ומסמך אחד שמתאר אותו.

  • התיעוד של ה-API (באנגלית): מפתחות והרשאות, המוסכמות, מגבלות הקצב, שיחות והרצות, webhooks, ודוגמה מלאה מקצה לקצה.
  • אוטומציה: איך משימה נולדת מטופס, מאימייל, מוואטסאפ או מלוח TODO, בלי קוד בכלל.
  • השוק: השירותים שקרינגל מחבר לאתרים ולאפליקציות.

איך מתחילים

  • נכנסים לפורטל ב-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"

מפתח הוא סיסמה. הוא נשמר בכספת או במשתני הסביבה של השרת שלכם, לעולם לא בקוד, לא בקומיט ולא בדפדפן של משתמש.

לתיעוד ה-API (באנגלית)

איפה כל דבר גר

הכתובות של Kringl
מהאיפה
האפליקציהweb.kringl.ai
ה-APIhttps://web.kringl.ai/api/v1
מפתחות APIweb.kringl.ai/account/apikeys
התיעודkringl.ai/docs
תנאים ופרטיותתנאי השימוש, מדיניות הפרטיות

משהו חסר בתיעוד? כותבים ל-info@wizzo.co.il ועונים לכם.