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

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

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

מבוא

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

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

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

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

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

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

לוחצים על יצירה.
התנאים וההגבלות החדשים מתווספים לקטע Terms and conditions (תנאים והגבלות) בדף Organization Profile (פרופיל הארגון).
כדי להוסיף עוד תנאים, חוזרים על שלבים 3 עד 5.
לוחצים על שמירה כדי לשמור את השינויים בפרופיל הארגון.

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

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

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

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

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

השלבים הבאים

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