आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
परिचय
किराये का प्लान पब्लिश करने से पहले, आपको अपनी संगठन प्रोफ़ाइल में नियम और शर्तें ("नियम और शर्तें") जोड़नी होंगी. नियम और शर्तें, संगठन की प्रोफ़ाइल से बाहर मौजूद हैं. अपनी संगठन प्रोफ़ाइल में, आपको शर्तों और नियमों की जगह (सार्वजनिक यूआरएल) बतानी होती है.
रेट प्लान पब्लिश करने के बाद, शर्तों और नियमों का मौजूदा वर्शन डेवलपर पोर्टल में दिखता है. डेवलपर, मौजूदा नियमों और शर्तों को स्वीकार करने के बाद ही कोई प्लान खरीद सकते हैं.
यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके नियम और शर्तें जोड़ना
- संगठन की प्रोफ़ाइल पेज के बारे में जानकारी में बताए गए तरीके से, संगठन की प्रोफ़ाइल पेज को ऐक्सेस करें.
- बदलाव करें पर क्लिक करें.
- संगठन की प्रोफ़ाइल पेज के नियम और शर्तें सेक्शन में जाकर, नियम और शर्तें जोड़ें पर क्लिक करें.
'नए नियम और शर्तें' डायलॉग बॉक्स दिखता है
- निम्नलिखित जानकारी दर्ज करें:
फ़ील्ड ब्यौरा लागू होने की तारीख नियम और शर्तों के लागू होने की तारीख. डिफ़ॉल्ट रूप से, यह मौजूदा तारीख पर सेट होता है. आपको मौजूदा या आने वाले समय की कोई तारीख डालनी होगी.
वर्शन नियम और शर्तों का वर्शन. वर्शन नंबर की मदद से, नियमों और शर्तों के अलग-अलग वर्शन को ट्रैक किया जा सकता है.
URL नियमों और शर्तों का यूआरएल.
- बनाएं पर क्लिक करें.
नए नियम और शर्तें, संगठन की प्रोफ़ाइल पेज के नियम और शर्तें सेक्शन में जोड़ दी गई हैं.
- अन्य नियम और शर्तें जोड़ने के लिए, तीसरे से लेकर पांचवें चरण तक दोहराएं.
- संगठन की प्रोफ़ाइल में किए गए बदलावों को सेव करने के लिए, सेव करें पर क्लिक करें.
यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, नियम और शर्तों में बदलाव करना
नियमों और शर्तों में सीधे तौर पर बदलाव नहीं किया जा सकता. इसके बजाय, आपको उन नियमों और शर्तों को मिटाना होगा जिनमें बदलाव करना है. इसके बाद, नियमों और शर्तों की नई एंट्री जोड़ें.
यूज़र इंटरफ़ेस का इस्तेमाल करके नियम और शर्तें मिटाना
- संगठन की प्रोफ़ाइल पेज के बारे में जानकारी में बताए गए तरीके से, संगठन की प्रोफ़ाइल पेज को ऐक्सेस करें.
- संगठन की प्रोफ़ाइल पेज पर, बदलाव करें पर क्लिक करें.
- नियम और शर्तों की सूची में, उस नियम और शर्तों पर कर्सर घुमाएं जिन्हें आपको मिटाना है.
पर क्लिक करें.
एपीआई का इस्तेमाल करके, नियम और शर्तों को मैनेज करना
एपीआई का इस्तेमाल करके, नियमों और शर्तों को मैनेज करें. इसके बारे में यहां बताया गया है.
एपीआई का इस्तेमाल करके नियम और शर्तें जोड़ना
/mint/organizations/{org_name}/tncs को POST अनुरोध भेजकर, नियम और शर्तें जोड़ें.
नियम और शर्तें जोड़ते समय, आपके पास ये विकल्प होते हैं:
- 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 अनुरोध भेजकर, खास नियम और शर्तें देखें. यहां {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
}एपीआई का इस्तेमाल करने वाले डेवलपर या कंपनी के लिए, नियमों और शर्तों वाले दस्तावेज़ को स्वीकार करना
किसी डेवलपर या कंपनी के लिए, नियम और शर्तों वाले दस्तावेज़ को स्वीकार करें. इसके लिए, यहां दिए गए एपीआई में से किसी एक पर POST अनुरोध करें:
/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 |
संगठन का नाम. |
लागू नहीं | नहीं |
अगले चरण
इस्तेमाल की जा सकने वाली मुद्राओं को मैनेज करें में जाकर, अपने संगठन के लिए सेट अप की गई मुद्राओं में, इस्तेमाल की जा सकने वाली अन्य मुद्राएं जोड़ने का तरीका जानें.