דף זה תורגם על ידי Cloud Translation API.

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

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

מבוא

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

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

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

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

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

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

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

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

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

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

נכנסים לדף 'פרופיל הארגון', כפי שמתואר בדף 'איך בודקים את הפרופיל של הארגון'.
בדף Organization Profile (פרופיל הארגון), לוחצים על Edit (עריכה).
ברשימת התנאים וההגבלות, מעבירים את סמן העכבר מעל התנאים וההגבלות שרוצים למחוק.
לוחצים על .

ניהול תנאים והגבלות באמצעות ה-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`	ארגון לתנאים ולהגבלות.	לא רלוונטי	לא

השלבים הבאים

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