מעבר לתוכן
Unisoftתיעוד למפתחים

REST API / v1

חברו את הכלים שלכם ל-Unisoft.

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

סביבת התיעוד · ייצורhttps://api.unisoft.world/integrations/v1

הקריאה הראשונה שלכם

התחילו בקריאת נתונים כדי לבדוק את החיבור לפני ביצוע כתיבה כלשהי.

1. הכנת המפתח

בממשק הניהול של Unisoft, פתחו את ״מפתחים״, צרו מפתח API והעניקו לו רק את ההרשאות הדרושות לאינטגרציה שלכם. העתיקו את המפתח בעת יצירתו.

2. בחירת הסביבה המתאימה

לסביבות הייצור והפיתוח יש שמות מתחם נפרדים. השתמשו במפתח שנוצר בסביבה שאליה אתם פונים.

PRODUCTION=https://api.unisoft.world/integrations/v1
DEVELOPMENT=https://kehilaapi.syn-assist.fr/integrations/v1

3. בדיקת החיבור

export UNISOFT_API_URL='https://api.unisoft.world/integrations/v1'
export UNISOFT_API_KEY='ke_live_REPLACE_WITH_YOUR_KEY'

curl --fail-with-body "$UNISOFT_API_URL/me" \
  --header "Authorization: Bearer $UNISOFT_API_KEY"

GET /me מחזירה את הארגון, את הרשאות המפתח ואת השפות שהופעלו. בדקו את המידע הזה לפני שתמשיכו.

דוגמה

{
  "success": true,
  "data": {
    "apiKey": {
      "id": "key_example",
      "name": "Example integration",
      "prefix": "ke_live_",
      "scopes": [
        "contacts:read"
      ]
    },
    "organisation": {
      "id": "org_example",
      "name": "Example organisation",
      "shortName": "Example",
      "defaultLanguage": "fr",
      "enabledLanguages": [
        "fr",
        "en"
      ]
    }
  }
}

4. קריאת אנשי הקשר הראשונים שלכם

לקריאה זו נדרשת ההרשאה contacts:read. פרמטרי החיפוש הזמינים מפורטים בתיעוד ה-API.

curl --fail-with-body "$UNISOFT_API_URL/contacts?limit=10" \
  --header "Authorization: Bearer $UNISOFT_API_KEY"

התיעוד המפורט זמין בצרפתית ובאנגלית. שמות הנתיבים, השדות והערכים הטכניים נשארים ללא שינוי.