मुख्य कंटेंट तक स्किप करें

क्लासिक परिदृश्य रेसिपी

concepts और scripting को वास्तविक वर्कफ़्लो में जोड़ें। हर परिदृश्य देता है: लक्ष्य → फ़्लो → UI में सीधे पेस्ट होने वाले स्क्रिप्ट → अपेक्षित परिणाम। सभी स्क्रिप्ट लॉजिक असली ऐप में एंड-टू-एंड सत्यापित है।

उदाहरण लोकल टेस्ट सर्वर (/oauth2/token, /protected, /echo, /json आदि) का उपयोग करते हैं। अपने API पर इंगित करते समय अपने पाथ और Pre-URL डालें।


सिनारियो 1: टोकन के लिए लॉगिन, पूरे ग्रुप के लिए ऑटो-जोड़ना​

लक्ष्य: लॉगिन API कॉल करें, टोकन सेव करें, और हर आगामी रिक्वेस्ट उसे अपने-आप जोड़े — कोई मैनुअल कॉपी नहीं।

रिक्वेस्ट A — लॉगिन (पोस्ट-रिस्पॉन्स स्क्रिप्ट टोकन सेव करता है)​

POST /oauth2/token, form body: grant_type=password&username=qruser&password=qrpass&client_id=qr-client&client_secret=qr-secret

पोस्ट-रिस्पॉन्स चेन में एक स्क्रिप्ट चरण जोड़ें:

async function onResponse(context, url, response) {
var j = response.body.parseJSON();
if (j && j.access_token) {
sdk.env.set('authToken', j.access_token); // store on the runtime blackboard
sdk.env.set('tokenType', j.token_type || 'Bearer');
}
return response;
}

रिक्वेस्ट B — टोकन जोड़ना (वही स्क्रिप्ट हर अधिकृत API में कॉपी हो सकती है)​

GET /protected, प्री-सेंड चेन में एक स्क्रिप्ट चरण जोड़ें:

async function onRequest(context, url, request) {
var tok = sdk.env.get('authToken'); // take from the blackboard
var ty = sdk.env.get('tokenType') || 'Bearer';
if (tok) { request.headers.set('Authorization', ty + ' ' + tok); }
return request;
}

अपेक्षित परिणाम​

क्रियापरिणाम
पहले A भेजें (लॉगिन)200, रिस्पॉन्स में access_token, टोकन सेव
फिर B भेजें (अटैच)200, रिस्पॉन्स {authorized:true, ...}
स्क्रिप्ट बंद करें, B फिर भेजें401 (प्री-सेंड चेन नहीं चलता → टोकन इंजेक्ट नहीं — प्रमाण कि जोड़ता स्क्रिप्ट ही है)

मुख्य बात: A और B उसी एनवायरनमेंट से बंधे उसी ग्रुप में होने चाहिए (रनटाइम वेरिएबल का स्कोप प्रति एनवायरनमेंट), और पाथ फ़्रैगमेंट एनवायरनमेंट का Pre-URL पूरा करता है।


सिनारियो 2: रिक्वेस्ट बॉडी का AES एन्क्रिप्शन, रिस्पॉन्स का डिक्रिप्शन (मल्टी-स्क्रिप्ट चेन)​

लक्ष्य: भेजने से पहले बॉडी AES-एन्क्रिप्ट करें (वायर पर केवल साइफ़रटेक्स्ट), आने के बाद रिस्पॉन्स डिक्रिप्ट करें; साथ ही कई स्क्रिप्ट की चेनिंग और उनके बीच डेटा साझा करना भी दिखाता है।

कई स्क्रिप्ट में क्यों बाँटा जा सकता है? एक ही चेन के स्क्रिप्ट globalThis शेयर करते हैं: स्क्रिप्ट ① कीज़/प्लेनटेक्स्ट रखती है, स्क्रिप्ट ②③ उठा लेते हैं। हर स्क्रिप्ट एक-उद्देश्यी रहता है और स्वतंत्र रूप से टॉगल हो सकता है।

प्री-सेंड चेन​

स्क्रिप्ट ① (संदर्भ और कीज़ तैयार करती है):

async function onRequest(context, url, request) {
globalThis.__traceId = $uuid.v4();
globalThis.__aesKey = '0123456789abcdef'; // 16 bytes → AES-128
globalThis.__aesIv = 'abcdef0123456789';
globalThis.__plain = request.body.parseText();
request.headers.set('X-Trace-Id', globalThis.__traceId);
return request;
}

स्क्रिप्ट ② (बॉडी एन्क्रिप्ट करती है):

async function onRequest(context, url, request) {
var cipher = $crypto.encryptAES(globalThis.__plain, globalThis.__aesKey, globalThis.__aesIv);
request.body = cipher; // only ciphertext on the wire
request.headers.set('X-Encrypt', 'AES-128-CBC');
return request;
}

(वैकल्पिक) स्क्रिप्ट ③ सिनारियो 1 की टोकन-अटैच लॉजिक जोड़ती है।

पोस्ट-रिस्पॉन्स चेन (डिक्रिप्ट + रिस्पॉन्स रीराइट)​

async function onResponse(context, url, response) {
var j = response.body.parseJSON();
var cipher = j && j.body && j.body.utf8; // /echo echoes the request body in body.utf8
var recovered = cipher ? $crypto.decryptAES(cipher, globalThis.__aesKey, globalThis.__aesIv) : '';
var obj = null; try { obj = JSON.parse(recovered); } catch (e) {}
response.body = JSON.stringify({
traceId: globalThis.__traceId, decrypted: recovered,
roundtripOk: recovered === globalThis.__plain, jsonValid: !!obj,
});
return response;
}

रिक्वेस्ट बॉडी (एन्क्रिप्शन से पहले): {"order":123,"note":"secret-payload","amount":99.5}

अपेक्षित परिणाम​

भेजने के बाद आपको मिलेगा:

{"traceId":"...","decrypted":"{\"order\":123,\"note\":\"secret-payload\",\"amount\":99.5}","roundtripOk":true,"jsonValid":true}
  • roundtripOk:true: डिक्रिप्ट किया परिणाम मूल प्लेनटेक्स्ट से बाइट-दर-बाइट मेल खाता है
  • रीराइट किया रिस्पॉन्स बॉडी परिणाम में दिखता है (प्रमाण कि पोस्ट-रिस्पॉन्स रीराइट असर करता है)

⚠️ $crypto के आर्गुमेंट पोज़िशनल स्ट्रिंग हैं; विफलता पर यह केवल Error: से शुरू होने वाली स्ट्रिंग लौटाता है — थ्रो या एबॉर्ट नहीं करता (सत्यापित: ख़राब साइफ़रटेक्स्ट → Invalid ciphertext, ग़लत key/iv → CryptoKit error)। ग़ैर-ASCII प्लेनटेक्स्ट सही एन्क्रिप्ट और डिक्रिप्ट होता है (पुराना दावा कि "ग़ैर-ASCII एबॉर्ट करता है" खंडित हो चुका है)। अगर डिक्रिप्ट किया परिणाम HTTP हेडर में लिखना हो, तो सुनिश्चित करें कि मान ASCII है (हेडर मान ग़ैर-ASCII अस्वीकार करते हैं, वरना TypeError थ्रो होता है); UTF-8 कंटेंट body या query params में रखें।


सिनारियो 3: एक्सट्रैक्ट · assertion · डायनामिक वेरिएबल · साइनिंग​

हल्की ऑटोमेशन का सेट — ज़्यादातर को JS की ज़रूरत नहीं, घोषणात्मक एक्सट्रैक्ट / assert चरण उपयोग करते हैं।

3.1 रिस्पॉन्स फ़ील्ड अगली रिक्वेस्ट को पास करें (एक्सट्रैक्ट)​

  • रिक्वेस्ट A के पोस्ट-रिस्पॉन्स चेन में एक्सट्रैक्ट चरण जोड़ें: वेरिएबल author, स्रोत response body JSON, एक्सप्रेशन $.slideshow.author।
  • रिक्वेस्ट B के प्री-सेंड चेन में स्क्रिप्ट चरण जोड़ें: var v=sdk.env.get('author'); if(v){ request.headers.set('X-Extracted', v); } return request;

सत्यापित: रिक्वेस्ट B का /echo एक X-Extracted हेडर गूँजता है जो रिक्वेस्ट A की रिस्पॉन्स के लेखक से मेल खाता है।

3.2 Assertions​

पोस्ट-रिस्पॉन्स चेन में assert चरण जोड़ें: स्टेटस कोड = 200, $.slideshow.title exists। परिणाम एक-एक करके सूचीबद्ध होते हैं (पास/फ़ेल, अपेक्षित vs वास्तविक)।

3.3 डायनामिक वेरिएबल​

उन्हें सीधे params / headers / URL में लिखें:

GET /echo?ts={{$timestamp}}&r={{$randomInt}}&u={{$uuid}}

सत्यापित: हर सेंड ts को मौजूदा टाइमस्टैम्प, r को अलग रैंडम पूर्णांक, और u को मान्य UUID के रूप में गूँजता है। पूरी सूची: concepts, डायनामिक वेरिएबल।

3.4 साइनिंग (MD5, मानक और इंटरऑपरेबल)​

कई ओपन API MD5(param concatenation + secret) से साइन करते हैं। सत्यापित-मानक $hash.md5 उपयोग करें:

async function onRequest(context, url, request) {
var appId = sdk.env.get('appId');
var secret = sdk.env.get('appSecret'); // keep secrets in environment variables
var ts = String(Math.floor(Date.now() / 1000));
var sign = $hash.md5(appId + ts + secret); // concatenation order per your backend's convention
request.queries.set('appId', appId);
request.queries.set('ts', ts);
request.queries.set('sign', sign);
return request;
}

सत्यापित: $hash.md5('abc') = 900150983cd24fb0d6963f7d28e17f72, बैकएंड से मेल।

✅ नेटिव $hmac ($hmac.sha256(message, key) आदि) वेक्टर-दर-वेक्टर सत्यापित है कि वह मानक RFC HMAC से मेल खाता है (आर्गुमेंट क्रम ध्यान दें: पहले डेटा, फिर की) और बाहरी साइनिंग के लिए उपयोग हो सकता है; $hash परिवार भी मानक है। केवल $jwt ऑब्जेक्ट payload को [object Object] में गिरा देता है (पहले JSON.stringify से stringify करें, या सर्वर पर साइन करें)।


सिनारियो 4: लाइब्रेरी स्क्रिप्ट और require() से साझा लॉजिक का पुनः उपयोग​

लक्ष्य: "टोकन इंजेक्ट", "एकीकृत साइनिंग" और "लॉगिंग" को पुनः उपयोग योग्य इकाइयों में निकालें — कई जगह संदर्भित करें, एक जगह बनाए रखें।

पुनः उपयोग के दो तरीके:

  • लाइब्रेरी स्क्रिप्ट चरण: अपने onRequest/onResponse वाला पूरा स्क्रिप्ट — इसे चरण के रूप में जोड़ें और यह क्रम में चलता है, बाकी चरणों के साथ globalThis शेयर करता है।
  • require(): शुद्ध फ़ंक्शन module.exports के साथ स्क्रिप्ट लाइब्रेरी में सेव करें, फिर किसी भी स्क्रिप्ट से लोड करें — साइनिंग हेल्पर, कोडेक और अन्य साझा यूटिलिटी के लिए सबसे अच्छा:
// script library "sign-lib" (no entry function needed)
function sign(method, path, body, secret) {
return $hmac.sha256(method + path + body, secret);
}
module.exports = { sign };
// any request script
async function onRequest(context, url, request) {
const { sign } = require('@libs/sign-lib');
request.headers.set('X-Sign', sign('POST', request.path, request.body.parseText(), sdk.env.get('appSecret')));
return request;
}

स्थिर आइडेंटिफ़ायर रूप के लिए लाइब्रेरी मैनेजर में Copy require statement उपयोग करें। बिल्ट-इन लाइब्रेरी (@libs/base64, @libs/hex) बिना सेटअप हर जगह उपलब्ध। पूरी मैकेनिक्स: scripting, require() से स्क्रिप्ट लाइब्रेरी लोड करना।


परिदृश्य चीट शीट​

मैं चाहता हूँ…कौन-से चरण
लॉगिन के बाद हर API पर टोकन ऑटो-अटैचपोस्ट-रिस्पॉन्स स्क्रिप्ट सेव करता + प्री-सेंड स्क्रिप्ट पढ़कर हेडर इंजेक्ट करता
रिक्वेस्ट बॉडी एन्क्रिप्ट / रिस्पॉन्स डिक्रिप्टप्री-सेंड $crypto.encryptAES + पोस्ट-रिस्पॉन्स decryptAES
रिस्पॉन्स फ़ील्ड अगली रिक्वेस्ट को पासएक्सट्रैक्ट चरण + वेरिएबल पढ़ने वाला स्क्रिप्ट
स्टेटस कोड / फ़ील्ड सत्यापितAssert चरण
हर सेंड पर रैंडम मान / टाइमस्टैम्प{{$uuid}} जैसे डायनामिक वेरिएबल
ओपन API साइन$hash.md5(...) (मानक)
वही लॉजिक कई जगहलाइब्रेरी स्क्रिप्ट, या स्क्रिप्ट लाइब्रेरी को require('@libs/<key>')