מפתחות API
ה-API של Coi מאפשר למערכות אחרות לקרוא ולעדכן את החנות: מחירים ומלאי, הזמנות, לקוחות רשומים ופניות. כל מערכת מתחברת עם מפתח API משלה, שאתם יוצרים בממשק הניהול וקובעים מה מותר לו לעשות.
1. יצירת מפתח
1 בממשק הניהול, היכנסו ל"חנות" ← "API ומפתחות", ולחצו על "מפתח חדש".
2 בשדה "שם המפתח" כתבו את שם המערכת שתשתמש בו, למשל "מערכת המלאי". כך תדעו בהמשך איזה מפתח שייך לאיזו מערכת.
3 בחרו את תוקף המפתח: ללא הגבלה, 30 יום, 90 יום או שנה.
4 קבעו את "הרשאות גישה" (בשלב הבא), ולחצו על "יצירת מפתח".
5 לחצו על "העתקה", והעבירו את המפתח למערכת שמתחברת, או לאיש המקצוע שמחבר אותה.
2. הרשאות גישה
לכל אחד מהתחומים - מוצרים, הזמנות, לקוחות רשומים ופניות - בוחרים אחת משלוש רמות:
| רמה | מה המערכת יכולה לעשות |
|---|---|
| ללא גישה | לא רואה את התחום בכלל |
| קריאה | רואה את הנתונים, ולא יכולה לשנות אותם |
| קריאה ועדכון | רואה ומעדכנת, למשל מחיר ומלאי של מוצר או סטטוס של הזמנה |
תנו לכל מערכת רק את מה שהיא צריכה. מערכת מלאי, למשל, צריכה "קריאה ועדכון" במוצרים, ו"ללא גישה" בכל השאר.
3. שמירה על המפתח
1 מפתח נפרד לכל מערכת. כך אפשר לנתק מערכת אחת בלי לפגוע באחרות. אפשר להחזיק עד 5 מפתחות פעילים.
2 מערכת שהפסקתם לעבוד איתה - מחקו את המפתח שלה, בכפתור "מחיקה" שליד המפתח. המערכת תתנתק מיד.
3 על כל יצירה או מחיקה של מפתח נשלח מייל לבעל האתר, כדי שתדעו על כל שינוי.
4. למפתחים
הכתובת של ה-API היא כתובת האתר עם /api/v1/, והמפתח נשלח בכותרת של הבקשה, רק ב-HTTPS:
Authorization: Bearer coi_sk_...
אפשר לשלוח עד 120 בקשות בדקה לכל מפתח. כל הפעולות, השדות והדוגמאות - בתיעוד של Coi API.