कस्टमर जर्नी API का अवलोकन

कस्टमर जर्नी API एक बैकएंड को प्रोग्रामेटिक रूप से कस्टमर जर्नी प्रबंधित करने देता है: जर्नी की परिभाषाएँ बनाएँ और संपादित करें, जर्नी को उनके जीवनचक्र (शुरू करें, रोकें, समाप्त करें, ड्राफ्ट करें, संग्रहीत करें) के माध्यम से आगे बढ़ाएँ, अपने सिस्टम से चल रही जर्नी को ट्रिगर करें, और प्रति-जर्नी आँकड़े प्राप्त करें।

यह वही API है जिसका उपयोग कस्टमर जर्नी बिल्डर करता है, जिसे gRPC-गेटवे ब्रिज के माध्यम से REST/JSON पर उपलब्ध कराया गया है।

बेस URL

gRPC-गेटवे मेथड्स और लिगेसी एक्सटर्नल मेथड्स अलग-अलग होस्ट पर सर्व किए जाते हैं:

मेथड्स	बेस URL
gRPC-गेटवे: `/api/v3/journeygateway/...` (जीवनचक्र, बनाएँ, अपडेट करें)	`https://journey-api.svc-nue.pushwoosh.com`
लिगेसी एक्सटर्नल: `/api/journey/...` (API द्वारा शुरू करें, आँकड़े, यूज़र्स को हटाएँ)	`https://journey.pushwoosh.com`

प्रमाणीकरण (Authentication)

प्रत्येक अनुरोध में सर्वर-साइड Pushwoosh API एक्सेस टोकन के साथ एक Authorization हेडर शामिल होना चाहिए:

Authorization: Api YOUR_API_TOKEN

मेथड्स

जर्नी प्रबंधित करें

जीवनचक्र (Lifecycle): POST /api/v3/journeygateway/{action}। किसी जर्नी को उसके UUID द्वारा शुरू करें, रोकें, समाप्त करें, ड्राफ्ट करें, या संग्रहीत करें।
बनाएँ और अपडेट करें: POST /api/v3/journeygateway और PUT /api/v3/journeygateway/{uuid}। एक नई जर्नी परिभाषा बनाएँ या किसी मौजूदा को बदलें।

जर्नी ट्रिगर करें

API द्वारा शुरू करें: POST /api/journey/{id}/start/external। पहले से चल रही जर्नी के API एंट्री पॉइंट में यूज़र्स को इंजेक्ट करें।

आँकड़े और ऑडियंस

जर्नी के आँकड़े प्राप्त करें: GET /api/journey/{id}/statistics/external। प्रति-पॉइंट डिलीवरी और कन्वर्ज़न मेट्रिक्स।
जर्नी से यूज़र्स को हटाएँ: POST /api/journey/drop-users/external। सभी या चयनित सक्रिय जर्नी से यूज़र्स को हटाएँ।

संदर्भ (Reference)

जर्नी ऑब्जेक्ट: जर्नी परिभाषा का आकार (जानकारी, पैरामीटर, पॉइंट्स, टिप्पणियाँ) जो जीवनचक्र, बनाने और अपडेट करने के मेथड्स द्वारा लौटाया जाता है।
पॉइंट संदर्भ: प्रत्येक पॉइंट प्रकार के लिए point_data संरचना: एंट्री, टाइमिंग, स्प्लिटिंग, एक्शन और मैसेजिंग एलिमेंट्स।

लाइफसाइकिल स्टार्ट बनाम API द्वारा स्टार्ट

कस्टमर जर्नी में दो ऑपरेशन होते हैं जो सुनने में एक जैसे लगते हैं लेकिन अलग-अलग व्यवहार करते हैं।

लाइफसाइकिल स्टार्ट जर्नी की स्थिति बदलता है (उदाहरण के लिए, ड्राफ्ट से रनिंग में)। API द्वारा स्टार्ट पहले से चल रही जर्नी में यूज़र्स को इंजेक्ट करता है। नीचे दी गई तालिका उनकी साथ-साथ तुलना करती है।

	लाइफसाइकिल स्टार्ट	API द्वारा स्टार्ट
एंडपॉइंट	`POST /api/v3/journeygateway/start`	`POST /api/journey/{id}/start/external`
यह क्या करता है	जर्नी को सक्रिय करता है और इसे रनिंग स्थिति में ले जाता है	पहले से चल रही जर्नी के API एंट्री पॉइंट में यूज़र्स को इंजेक्ट करता है
आवश्यक जर्नी स्थिति	ड्राफ्ट या पॉज़्ड	रनिंग (एक API स्टार्ट पॉइंट के साथ)
रन फ्रीक्वेंसी	प्रति स्थिति परिवर्तन पर एक बार	बार-बार, जैसे ही यूज़र्स को प्रवेश करने की आवश्यकता होती है

अनुरोध और प्रतिक्रिया प्रारूप

कंटेंट प्रकार: application/json।
v3 फ़ील्ड नाम snake_case का उपयोग करते हैं। Enum मानों को उनके स्ट्रिंग नामों के रूप में क्रमबद्ध किया जाता है (उदाहरण के लिए, "STATUS_RUNNING", "POINT_TYPE_SEND_PUSH")।
gRPC-गेटवे मेथड्स (/api/v3/journeygateway/...) सफलता पर जर्नी ऑब्जेक्ट और विफलता पर मानक gRPC-गेटवे त्रुटि लिफाफा लौटाते हैं: { "code": ..., "message": ..., "details": [...] }।
लिगेसी एक्सटर्नल मेथड्स (/api/journey/...) सफलता पर एक मेथड-विशिष्ट JSON बॉडी और सत्यापन त्रुटियों पर HTTP 400 के साथ { "success": false, "message": ... } लौटाते हैं।

त्वरित शुरुआत

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/start \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

अगले कदम

जीवनचक्र (Lifecycle)

बनाएँ और अपडेट करें

API द्वारा शुरू करें

जर्नी के आँकड़े प्राप्त करें

जर्नी से यूज़र्स को हटाएँ

जर्नी ऑब्जेक्ट

पॉइंट संदर्भ