לדלג לתוכן הראשי

ממשק ה-API של Teachworks

נכתב על ידי Teachworks Support

ממשק ה-API של Teachworks הוא ממשק תכנות יישומים המאפשר לך גישה לנתונים בחשבון Teachworks שלך על מנת לפתח אינטגרציות ותוכנות מותאמות אישית.

הערה: גישת API זמינה רק לחברות עם מנויים "צמיחה" ו-"פרימיום".

הפעלת ה-API

  1. לחצו על "חשבון" ולאחר מכן על "אינטגרציות ותוספות".

  2. השתמש בשדה "חיפוש" בחלק העליון והזן "API".

  3. העבר את המתג למצב "מופעל" כדי להפעיל את ה-API.

נוֹהָג

לאחר שהפעלתם את ה-API, תוכלו ללחוץ על הקישור "הגדרות". תוכלו ליצור את אסימון ה-API של Teachworks על ידי לחיצה על כפתור "יצירת אסימון API".

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

ניתן גם ללחוץ על כפתור "צור חשבון ארגז חול" אם ברצונך ליצור חשבון ארגז חול לבדיקת שילוב ה-API שלך לפני חיבורו לחשבון הפעיל של החברה שלך.

תיעוד API

ניתן למצוא את התיעוד עבור ה-API שלנו כאן: מסמכי API של Teachworks. נוסיף נקודות קצה נוספות ל-API לצורך גישה לסוגי נתונים נוספים וניהול רשומות.

אם אתם מעוניינים בנקודת קצה שאינה זמינה כעת, אנא צרו איתנו קשר בכתובת support@teachworks.com ואנו נבדוק את האפשרות להוסיפה.

האם קיבלת תשובה לשאלתך?