הגדרת מילונים ורשימות ארגוניים בממשק API

שלב 1: יצירת API Key

1. היכנסו: Settings → Public API Keys.

2. לחצו Create Public API Key.

3. הזינו Key Name ובחרו Expiration Date אם רלוונטי, לחצו Create.

4. העתיקו את ה־API Key.

5. חשוב: בצעו שמירה בתחתית מסך הגדרות החברה לאחר יצירת המפתח.

באמצעות הAPI יש לייצר בקשה מסוג POST אשר מזדהה מול מערכת Vitre באמצעות הAPI KEY שהועתק קודם לכן.
ממשק הAPI מקבל קריאה הרשומה ב-JSON בלבד.
יש לייצר את הקריאה על פי המבנה הבא:

{
  "name": "string",
  "values": [
    {
      "childDictionaryId": 0,
      "value": "string",
      "position": 0,
      "translations": "string",
      "externalId": "string"
    }
  ]
}

הסבר שדות

• • name: שם המילון. חובה.

  • values: מערך של ערכי מילון. לפחות ערך אחד.

    • childDictionaryId: מזהה מילון־בן לקישור היררכי. אופציונלי. אם מקשרים, יש ליצור תחילה את מילון־הבן ולקחת את ה־ID שלו. אם לא מקשרים, ניתן להשמיט את השדה.

    • value: תיאור הערך. חובה.

    • position: מיקום הערך ברשימה. אופציונלי. אם מושמט, הסדר יהיה לפי סדר ההופעה ב־JSON.

    • translations: מחרוזת JSON של תרגומים לשפות. אופציונלי.
      דוגמה: "{\"en-US\":\"Gloves\",\"he-IL\":\"כפפות\",\"ru-RU\":\"Перчатки\"}"

    • externalId: מזהה חיצוני לערך כפי שמוגדר במערכות פנים ארגוניות. מומלץ לצורך סנכרון עתידי.
      
      

טיפים ובקרות איכות

• אם יצרתם API Key חדש והוא “לא עובד”, ודאו שביצעתם Save במסך ההגדרות אחרי היצירה.

• translations: השדה מקבל מחרוזת שמכילה JSON. ודאו בריחה תקינה של גרשיים.

• externalId: שמרו על ייחודיות ברמת הארגון כדי למנוע כפילויות ובאגי סנכרון.

• בעבודה היררכית: צרו קודם את מילון־הבן, שלפו את ה־ID, ואז קשרו אותו דרך childDictionaryId.

• בדיקות מהירות: התחילו בערך אחד בלבד, ודאו שנוצר, ואז הרחיבו רשימה.