नियम और शर्तें मैनेज करें

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

शुरुआती जानकारी

रेट प्लान को पब्लिश करने से पहले, आपको अपनी संगठन की प्रोफ़ाइल में नियम और शर्तें ("नियम और शर्तें") जोड़नी होंगी. नियम और शर्तें, संगठन की प्रोफ़ाइल से बाहर की हैं. अपने संगठन की प्रोफ़ाइल में, आपको नियमों और शर्तों की जगह (सार्वजनिक यूआरएल) की जानकारी देनी होती है.

रेट प्लान पब्लिश करने के बाद, नियमों और शर्तों का मौजूदा वर्शन डेवलपर पोर्टल में दिखता है. डेवलपर कोई प्लान तभी खरीद सकते हैं, जब वे मौजूदा नियमों और शर्तों को स्वीकार कर लें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके नियम और शर्तें जोड़ना

  1. संगठन की प्रोफ़ाइल वाले पेज को एक्सप्लोर करना में बताए गए तरीके से, संगठन की प्रोफ़ाइल वाले पेज को ऐक्सेस करें.
  2. बदलाव करें पर क्लिक करें.
  3. संगठन की प्रोफ़ाइल वाले पेज पर मौजूद नियम और शर्तें सेक्शन में, नियम और शर्तें जोड़ें पर क्लिक करें.

    नए नियम और शर्तों वाला डायलॉग बॉक्स दिखेगा

  4. निम्नलिखित जानकारी दर्ज करें:
    फ़ील्ड ब्यौरा
    लागू होने की तारीख

    नियम और शर्तें लागू होने की तारीख. डिफ़ॉल्ट तारीख, मौजूदा तारीख होती है. आपको वर्तमान या भविष्य की कोई तारीख डालनी होगी.
    वर्शन

    नियमों और शर्तों का वर्शन. वर्शन नंबर की मदद से, नियमों और शर्तों के अलग-अलग वर्शन पर नज़र रखी जा सकती है.
    यूआरएल

    नियम और शर्तों का यूआरएल.
  5. बनाएं पर क्लिक करें.

    नए नियम और शर्तें, संगठन की प्रोफ़ाइल वाले पेज के 'नियम और शर्तें' सेक्शन में जोड़े गए हैं.

  6. अतिरिक्त नियम और शर्तें जोड़ने के लिए, तीसरे से लेकर पांचवें चरण को दोहराएं.
  7. संगठन की प्रोफ़ाइल में किए गए बदलावों को सेव करने के लिए, सेव करें पर क्लिक करें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके नियम और शर्तों में बदलाव करना

आप नियम और शर्तों में सीधे तौर पर बदलाव नहीं कर सकते. इसकी जगह, आपको वे नियम और शर्तें मिटानी होंगी जिनमें आप बदलाव करना चाहते हैं. इसके बाद, नई नियम और शर्तें जोड़ें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके नियम और शर्तें मिटाना

  1. संगठन की प्रोफ़ाइल वाले पेज को एक्सप्लोर करना में बताए गए तरीके से, संगठन की प्रोफ़ाइल वाले पेज को ऐक्सेस करें.
  2. संगठन की प्रोफ़ाइल वाले पेज पर, बदलाव करें पर क्लिक करें.
  3. नियमों और शर्तों की सूची में, कर्सर को उन नियमों पर रखें जिन्हें आपको मिटाना है.
  4. पर क्लिक करें.

API का इस्तेमाल करके नियम और शर्तें मैनेज करना

यहां दिए गए सेक्शन में बताए गए तरीके से, एपीआई का इस्तेमाल करके नियम और शर्तें मैनेज करें.

एपीआई का इस्तेमाल करके नियम और शर्तें जोड़ना

/mint/organizations/{org_name}/tncs पर पोस्ट अनुरोध जारी करके नियम और शर्तें जोड़ें. नियम और शर्तें जोड़ते समय, आपके पास यह तय करने का विकल्प होता है:

  • यूआरएल
  • साथ का टेक्स्ट (जैसे कि ब्यौरा)
  • नियम और शर्तें लागू होने की तारीख
  • वर्शन नंबर

इन विकल्पों के बारे में ज़्यादा जानकारी के लिए, नियम और शर्तों की कॉन्फ़िगरेशन प्रॉपर्टी देखें.

उदाहरण के लिए:

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 का इस्तेमाल करके नियम और शर्तें देखना

किसी संगठन के नियम और शर्तें या सभी नियम और शर्तें देखें.

/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

/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
}

एपीआई का इस्तेमाल करके, डेवलपर या कंपनी के लिए नियम और शर्तों से जुड़ा दस्तावेज़ स्वीकार करना

नीचे दिए गए एपीआई में से किसी एक को पोस्ट अनुरोध जारी करके, किसी खास डेवलपर या कंपनी के लिए नियम और शर्तें स्वीकार करने वाला दस्तावेज़ स्वीकार करना:

  • /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

यहां जवाब का एक उदाहरण दिया गया है:

ध्यान दें: रिस्पॉन्स पेलोड में, auditDate को यूटीसी में मौजूदा समय पर सेट किया जाता है.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

एपीआई का इस्तेमाल करके, डेवलपर या कंपनी की ओर से स्वीकार किए गए नियम और शर्तें देखना

नीचे दिए गए किसी एक एपीआई को जीईटी अनुरोध जारी करके, किसी खास डेवलपर या कंपनी ने जो नियम और शर्तें स्वीकार की हैं उन्हें देखें:

  • /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 का इस्तेमाल करके नियम और शर्तों में बदलाव करना

नियमों और शर्तों में बदलाव करने के लिए, /mint/organizations/{org_named}/tncs/{tncs_id} को PUT अनुरोध जारी करें. इसमें {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 का इस्तेमाल करके नियम और शर्तें मिटाना

/mint/organizations/{org_name}/tncs/{tncs_id} को DELETE अनुरोध भेजकर नियम और शर्तें मिटाएं, जहां {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

एपीआई के लिए नियम और शर्तों की कॉन्फ़िगरेशन प्रॉपर्टी

नीचे दी गई टेबल में उन कॉन्फ़िगरेशन प्रॉपर्टी की खास जानकारी दी गई है जिन्हें एपीआई का इस्तेमाल करके, नियम और शर्तों के लिए सेट किया जा सकता है.

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
url

नियमों और शर्तों का यूआरएल.

 लागू नहीं नहीं
tncText

नियमों और शर्तों के लिए टेक्स्ट (जैसे कि कम शब्दों में जानकारी).

 लागू नहीं नहीं
version

नियमों और शर्तों का वर्शन. वर्शन नंबर की मदद से, नियम और शर्तें के अलग-अलग वर्शन पर नज़र रखी जा सकती है.

 लागू नहीं हां
startDate

नियम और शर्तें लागू होने की तारीख.

 लागू नहीं हां
organization

नियम और शर्तें से जुड़े संगठन.

 लागू नहीं नहीं

अगले चरण

जिन मुद्राओं को मैनेज करें सेक्शन में जाकर, उन मुद्राओं को जोड़ने का तरीका जानें जिन्हें आपके संगठन के लिए शुरुआत में सेट अप किया गया था.