ניהול התנאים וההגבלות

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

מבוא

לפני שמפרסמים תוכנית תמחור ותשלומים, צריך להוסיף את התנאים וההגבלות ("התנאים וההגבלות") לפרופיל של הארגון. התנאים וההגבלות נמצאים מחוץ לפרופיל הארגון. בפרופיל הארגון, צריך לציין את המיקום (כתובת ה-URL הציבורית) של התנאים וההגבלות.

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

הוספת תנאים והגבלות באמצעות ממשק המשתמש

  1. נכנסים לדף 'פרופיל הארגון' כמו שמתואר בצפייה בדף 'פרופיל הארגון'.
  2. לוחצים על עריכה.
  3. בקטע 'תנאים והגבלות' בדף 'פרופיל הארגון', לוחצים על Add terms and conditions.

    תיבת הדו-שיח 'תנאים והגבלות חדשים' מוצגת

  4. הזן את המידע הבא:
    שדה התיאור
    מועד הכניסה לתוקף

    התאריך שבו נכנסו לתוקף התנאים וההגבלות. ברירת המחדל היא התאריך הנוכחי. עליך להזין את התאריך הנוכחי או תאריך עתידי.
    גרסה

    גרסה של התנאים וההגבלות. מספר הגרסה מאפשר לך לעקוב אחרי גרסאות שונות של התנאים וההגבלות.
    כתובת URL

    כתובת ה-URL של התנאים וההגבלות.
  5. לוחצים על יצירה.

    התנאים וההגבלות החדשים יתווספו לקטע 'תנאים והגבלות' בדף 'פרופיל הארגון'.

  6. חוזרים על שלבים 3 עד 5 כדי להוסיף עוד תנאים והגבלות.
  7. לוחצים על שמירה כדי לשמור את השינויים בפרופיל הארגון.

עריכת התנאים וההגבלות באמצעות ממשק המשתמש

לא ניתן לערוך את התנאים וההגבלות באופן ישיר. במקום זאת, צריך למחוק את התנאים וההגבלות שרוצים לערוך, ולהוסיף רשומה חדשה של תנאים והגבלות.

מחיקת התנאים וההגבלות באמצעות ממשק המשתמש

  1. נכנסים לדף 'פרופיל הארגון' כמו שמתואר בצפייה בדף 'פרופיל הארגון'.
  2. לחץ על עריכה בדף 'פרופיל ארגון'.
  3. ברשימת התנאים וההגבלות, מציבים את הסמן מעל לתנאים ולהגבלות שרוצים למחוק.
  4. לוחצים על .

ניהול התנאים וההגבלות באמצעות ה-API

נהל את התנאים וההגבלות באמצעות ה-API, כמתואר בסעיפים הבאים.

הוספת תנאים והגבלות באמצעות ממשק API

ניתן להוסיף תנאים והגבלות על ידי שליחה של בקשת POST אל /mint/organizations/{org_name}/tncs. כשמוסיפים את התנאים וההגבלות, אפשר לציין:

  • כתובת URL
  • טקסט נלווה (למשל תיאור)
  • התאריך שבו התנאים וההגבלות נכנסו לתוקף
  • מספר גרסה

למידע נוסף על האפשרויות האלה, עיינו במאפיינים של הגדרת התנאים וההגבלות.

לדוגמה:

curl -X POST   "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "url":"www.testoperator/termsandconditions",
     "tncText":"Sample text for the T&C",
     "version":"1.1",
     "startDate":"2018-09-24"
  }' \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
   "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
   "organization" : {     
     …
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.1"
 }

הצגת התנאים וההגבלות באמצעות ממשק ה-API

להציג את התנאים וההגבלות הספציפיים או את כל התנאים וההגבלות לארגון.

ניתן להציג תנאים והגבלות ספציפיים על ידי שליחה של בקשת GET אל /mint/organizations/{org_name}/tncs/{tncs_id}. {tncs_id} הוא הזיהוי של התנאים וההגבלות הספציפיים (המזהה מוחזר בתגובה כשיוצרים אותם). לדוגמה:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

כדי להציג את כל התנאים וההגבלות של הארגון, יש לשלוח בקשת GET אל /mint/organizations/{org_name}/tncs. לדוגמה:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Accept: application/json" \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{

"tnc" : [
  {
    "id" : "77193339-8d79-44a8-8af2-3593f16c158e",
    "organization" :
    {
      ...
    },
   "startDate" : "2018-07-01 00:00:00",
   "tncText" : "Big operator text for the T&C",
   "url" : "www.bigoperator/termsandconditions",
   "version" : "1.0"
  },
  {
    "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
    "organization" : {
    ...
  },
    "startDate" : "2018-09-24 00:00:00",
    "tncText" : "Sample text for the T&C",
    "url" : "www.testoperator/termsandconditions",
    "version" : "1.1"
  }
  ]
   "totalRecords" : 2
}

קבלת מסמך תנאים והגבלות עבור מפתח או חברה המשתמשים ב-API

כדי לאשר מסמך של התנאים וההגבלות למפתח או לחברה ספציפיים, צריך לשלוח בקשת POST לאחד מממשקי ה-API הבאים, בהתאמה:

  • /mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs

כאשר {dev_id} הוא מזהה המפתח (כתובת אימייל), {company_id} הוא מספר החברה ו-{tncs_id} הוא מזהה המסמך של התנאים וההגבלות.

לדוגמה:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "action":"ACCEPTED",
     "auditDate":"2018-10-01 00:00:00"
  }' \
  -u email:password

למטה מוצגת דוגמה לתשובה:

הערה: במטען הייעודי (payload) של התגובה, הערך auditDate מוגדר לזמן הנוכחי לפי שעון UTC.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

הצגת התנאים וההגבלות שאושרו על ידי מפתח או חברה המשתמשים ב-API

אפשר להציג את התנאים וההגבלות שאושרו על ידי מפתח או חברה ספציפיים, על ידי שליחת בקשת GET לאחד מממשקי ה-API הבאים, בהתאמה:

  • /mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/developer-tncs

כאשר {dev_id} הוא מזהה המפתח (כתובת אימייל) ו-{company_id} הוא מזהה החברה.

לדוגמה:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
  -H "Accept:application/json"  \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
  "developerTnc": [
  {
    "action": "ACCEPTED",
    "auditDate": "2018-08-29 07:24:45",
    "id": "dev2@myorg.com",
    "tnc": {
      "id": "26abc14c-c628-4c38-8840-a343c8ee9437",
      ...
    }
  }],
  "totalRecords": 1
}

עריכת התנאים וההגבלות באמצעות ה-API

לערוך את התנאים וההגבלות על ידי שליחה של בקשת PUT אל /mint/organizations/{org_named}/tncs/{tncs_id}. הערך {tncs_id} הוא הזיהוי של התנאים וההגבלות. כשמבצעים את העדכון, צריך לציין בגוף הבקשה את ההגדרות המעודכנות ואת הזיהוי של התנאים וההגבלות. לדוגמה, בבקשה הבאה מתבצעת עריכה של מספר הגרסה של התנאים וההגבלות (הנכס המעודכן מודגש בדוגמה):

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
  -H "Content-Type: application/json" \
  -d {
    "id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
    "version":"1.2"
  }' \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
   "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9",
   "organization" : {
       "address" : [ {
       "address1" : "Test address",
       "city" : "Test City",
       "country" : "US",
       "id" : "test-address",
       "isPrimary" : true,
       "state" : "CA",
       "zip" : "54321"
     } ],
     …"
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.2"
 }

מחיקת תנאים והגבלות באמצעות ה-API

כדי למחוק את התנאים וההגבלות צריך לשלוח בקשת DELETE אל /mint/organizations/{org_name}/tncs/{tncs_id}. {tncs_id} הוא הזיהוי של התנאים וההגבלות. לדוגמה:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

מאפייני הגדרת תנאים והגבלות ל-API

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

שם התיאור ברירת המחדל חובה?
url

כתובת ה-URL של התנאים וההגבלות.

 לא רלוונטי לא
tncText

טקסט (למשל תיאור קצר) של התנאים וההגבלות.

 לא רלוונטי לא
version

גרסת התנאים וההגבלות. מספר הגרסה מאפשר לך לעקוב אחרי הגרסאות השונות של התנאים וההגבלות.

 לא רלוונטי כן
startDate

התאריך שבו התנאים וההגבלות נכנסו לתוקף.

 לא רלוונטי כן
organization

ארגון התנאים וההגבלות.

 לא רלוונטי לא

השלבים הבאים

במאמר ניהול מטבעות נתמכים מוסבר איך להוסיף מטבעות נתמכים למטבעות שהוגדרו בהתחלה בארגון.