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

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

परिचय

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/mint/organizations/{org_name}/tncs/{tncs_id} पर 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

/mint/organizations/{org_name}/tncs को GET अनुरोध भेजकर, संगठन के लिए सभी नियम और शर्तें देखें. उदाहरण के लिए:

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",
      ...
  }
}

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

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

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

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

नियम और शर्तों में बदलाव करने के लिए, /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"
 }

एपीआई का इस्तेमाल करके, नियम और शर्तें मिटाना

/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

नियमों और शर्तों के लिए संगठन.

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

अगले चरण

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