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

אתם צופים במסמכי העזרה של Apigee Edge.
לעיון במאמרי העזרה של Apigee X. מידע

מבוא

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

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

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

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

   תיפתח תיבת הדו-שיח 'תנאים והגבלות חדשים'.

4. הזן את המידע הבא:

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

5. לוחצים על יצירה.

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

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

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

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

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

1. נכנסים לדף 'פרופיל הארגון', כפי שמתואר בקטע הצגת הדף 'פרופיל הארגון'.
2. בדף Organization Profile (פרופיל הארגון), לוחצים על Edit (עריכה).
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

דוגמה לתגובה:

{
  "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	הארגון של התנאים וההגבלות.	לא רלוונטי	לא

השלבים הבאים

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