# API-आधारित एंट्री

<Aside type="caution" icon="setting" title="डेवलपर सहायता की आवश्यकता है">
 आपको API-आधारित एंट्री जर्नी सेट अप करने के लिए अपनी डेवलपमेंट टीम से मदद की आवश्यकता होगी। कृपया इस गाइड को उनके साथ साझा करें।
</Aside>

## यह कैसे काम करता है

API-आधारित एंट्री आपको एक विशिष्ट व्यावसायिक इवेंट होने के तुरंत बाद एक कस्टमर जर्नी लॉन्च करने की अनुमति देती है। एक अभियान शुरू करने के लिए, आपको एक विशेष API अनुरोध भेजना होगा।

API-आधारित एंट्री के लिए कुछ उपयोग के मामले यहां दिए गए हैं:

* ग्राहकों को सूचित करें जब उत्पाद स्टॉक में वापस आ जाएं
* उपयोगकर्ताओं को बताएं कि एक लोकप्रिय उत्पाद की कीमत कम हो गई है
* सब्सक्राइबर्स को सूचित करें जब एक नया पॉडकास्ट एपिसोड जारी हो

नियमित इवेंट्स के विपरीत, ये सभी व्यावसायिक इवेंट्स ऐप के बाहर हो सकते हैं। उदाहरण के लिए, किसी उत्पाद की उपलब्धता केवल एक बाहरी डेटाबेस में जाँची जा सकती है। यहीं पर API-आधारित एंट्री काम आती है: आप ऐप के बाहर कुछ बदलाव होने पर (उदाहरण के लिए, आपके बाहरी डेटाबेस में) जर्नी लॉन्च करने के लिए एक अनुरोध भेजने का सेटअप कर सकते हैं।

<img src="/shared-33.webp" alt="जर्नी कैनवास पर API-आधारित एंट्री एलिमेंट"/>

यह इस प्रकार काम करता है:

1. API-आधारित एंट्री के साथ एक जर्नी बनाएं। एंट्री सेटिंग्स में, आपको उस अनुरोध का टेम्पलेट मिलेगा जो जर्नी को लॉन्च करता है।
2. [सेगमेंटेशन भाषा](/hi/developer/api-reference/segmentation-filters-api/segmentation-language) का उपयोग करके अनुरोध में सेगमेंटेशन शर्तें जोड़ें। आप संदर्भ के आधार पर संदेश सामग्री को बदलने के लिए अनुरोध में सामग्री प्लेसहोल्डर भी जोड़ सकते हैं।
3. यदि आवश्यक हो तो अनुरोध को स्वचालित करें। उदाहरण के लिए, मूल्य परिवर्तन के बारे में जानकारी तुरंत डेटाबेस से वेबहूक पर भेजी जा सकती है। एक बार ऐसा होने पर, वेबहूक को जर्नी लॉन्च करने के लिए स्वचालित रूप से अनुरोध भेजना चाहिए। यदि आपको स्वचालन की आवश्यकता नहीं है तो आप अनुरोध को मैन्युअल रूप से भी भेज सकते हैं।

आप सेगमेंटेशन शर्तों या संदेश सामग्री को बदलने के लिए अनुरोध को असीमित संख्या में भेज सकते हैं।

अधिक जानकारी के लिए, नीचे दिए गए निर्देशों का पालन करें।

## API-आधारित एंट्री के साथ एक जर्नी सेट अप करें

1. API-आधारित एंट्री के साथ एक जर्नी बनाएं:

<video src="/journey-elements-api-based-entry-1.webm" title="एक नई जर्नी बनाएं और API-आधारित एंट्री चुनें" autoplay loop muted playsinline />

2. API-आधारित एंट्री स्टेप पर डबल-क्लिक करें। एंट्री कॉन्फ़िगरेशन विंडो खुल जाएगी।

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

> उदाहरण के लिए, आप सब्सक्राइबर्स को सूचित करने के लिए एक जर्नी बना रहे हैं जब एक नया पॉडकास्ट एपिसोड जारी होता है। एक सामग्री प्लेसहोल्डर का उपयोग करके, आप हर बार जर्नी लॉन्च करने पर पॉडकास्ट शीर्षक बदल सकते हैं।

सबसे पहले, API-आधारित एंट्री सेटअप विंडो में प्लेसहोल्डर नाम जोड़ें। आप अपनी सुविधा के अनुसार कोई भी नाम उपयोग कर सकते हैं।

<img src="/journey-elements-api-based-entry-2.webp" alt="API-आधारित एंट्री सेटअप विंडो में कंटेंट प्लेसहोल्डर नाम जोड़ें"/>

अब, एक [पुश प्रीसेट](/hi/product/content/push-presets) या [ईमेल सामग्री](/hi/product/content/email-content/) बनाएं और उस टेक्स्ट के बजाय प्लेसहोल्डर डालें जिसे आप संशोधित करना चाहते हैं। प्लेसहोल्डर आपकी आवश्यकताओं के आधार पर निम्नलिखित प्रारूपों में से एक में होना चाहिए:

* `{placeholder_name|format_modifier|}` – यदि अभियान लॉन्च करते समय प्लेसहोल्डर मान निर्दिष्ट नहीं किया गया है, तो उपयोगकर्ताओं को इसके स्थान पर खाली जगह दिखाई देगी।
* `{placeholder_name|format_modifier}` – यदि प्लेसहोल्डर मान निर्दिष्ट नहीं किया गया है और पहले से ही किसी उपयोगकर्ता को असाइन नहीं किया गया है (यदि आपने प्लेसहोल्डर के रूप में टैग का उपयोग किया है), तो संदेश नहीं भेजा जाएगा।

<details>

<summary>प्रारूप संशोधक</summary>

* **CapitalizeFirst** – प्लेसहोल्डर मान में पहले अक्षर को बड़ा करता है
* **CapitalizeAllFirst** – प्लेसहोल्डर मान में सभी शब्दों के पहले अक्षरों को बड़ा करता है
* **UPPERCASE** – सभी अक्षरों को अपरकेस में बदलता है
* **lowercase** – सभी अक्षरों को लोअरकेस में बदलता है
* **regular** – अनुरोध में निर्दिष्ट के अनुसार प्लेसहोल्डर मान डालता है

</details>

<img src="/journey-elements-api-based-entry-3.webp" alt="गतिशील सामग्री के लिए पुश प्रीसेट में एक प्लेसहोल्डर डालें"/>

<Aside type="tip">
आप प्लेसहोल्डर नाम के बजाय एक [मौजूदा टैग](/hi/product/audience-data-and-segmentation/user-data-tags/) नाम का भी उपयोग कर सकते हैं। इस मामले में, आपको नीचे वर्णित अनुसार अनुरोध में निर्दिष्ट मान द्वारा इस टैग मान को ओवरराइट करने के लिए कॉन्फ़िगर करना होगा।
</Aside>

अपनी जर्नी में पुश या ईमेल एलिमेंट को कॉन्फ़िगर करते समय, बनाए गए प्रीसेट का चयन करें और **इवेंट विशेषताओं के साथ संदेश को वैयक्तिकृत करें** विकल्प चालू करें।

उन प्लेसहोल्डर्स का चयन करें जिन्हें आप जर्नी लॉन्च करते समय अनुरोध में संशोधित करना चाहते हैं। स्रोत के रूप में **API-आधारित एंट्री** और गतिशील विशेषता के रूप में प्लेसहोल्डर नाम चुनें:

<video src="/journey-elements-api-based-entry-4.webm" title="API-आधारित एंट्री से इवेंट विशेषताओं के साथ संदेश को वैयक्तिकृत करें" autoplay loop muted playsinline />

परिवर्तनों को सहेजने के लिए **लागू करें** पर क्लिक करें।

4. एंट्री कॉन्फ़िगरेशन विंडो में, इसे संशोधित करने के लिए अनुरोध टेम्पलेट की प्रतिलिपि बनाएँ:

<img src="/journey-elements-api-based-entry-5.webp" alt="API-आधारित एंट्री कॉन्फ़िगरेशन विंडो से अनुरोध टेम्पलेट कॉपी करें"/>
<Aside> 
API के माध्यम से एक जर्नी लॉन्च करने के लिए, आपको प्राधिकरण हेडर में एक मान्य प्राधिकरण टोकन शामिल करना होगा।

**आवश्यक हेडर प्रारूप**

  ```http
  Authorization: Api <your_api_token>
  ```
  **उदाहरण**

  ```http
  Authorization: Api c8dc6435-xxxxxxxxxxxxxxx
  ```
  
 </Aside>


5. [सेगमेंटेशन भाषा](/hi/developer/api-reference/segmentation-filters-api/segmentation-language) का उपयोग करके `"filter"` पैरामीटर में ऑडियंस फ़िल्टर जोड़ें या अपने सेगमेंट से [सेगमेंटेशन भाषा की प्रतिलिपि बनाएँ](/hi/product/audience-data-and-segmentation/segmentation/#copy-segment-logic)। आवश्यक [टैग](/hi/product/audience-data-and-segmentation/user-data-tags/tags) पहले से सेट अप करें।

उदाहरण के लिए, उन उपयोगकर्ताओं को लक्षित करने के लिए जिन्होंने अपनी _विशलिस्ट_ में _सॉक्स_ आइटम जोड़ा है, `"filter"` मान इस तरह दिखना चाहिए:

`"filter": "A(\"12345-12345\") * "T(\"Wishlist\", EQ, \"Socks\")"`

इस उदाहरण में, आपके ऐप में एक _विशलिस्ट_ टैग कॉन्फ़िगर होना चाहिए।

<Aside type="note">
आपका एप्लिकेशन कोड स्वचालित रूप से `A(\"12345-12345\")` प्रारूप में `"filter"` पैरामीटर में जोड़ा जाता है। इसे न हटाएं या संशोधित न करें।

साथ ही, कृपया ध्यान रखें कि JSON प्रश्नों में उद्धरण ("") और बैकस्लैश (\\) को बैकस्लैश (\\) से एस्केप किया जाना चाहिए।
</Aside>

<Aside type="tip">
आप फ़िल्टर का उपयोग करने के बजाय `"hwids"` पैरामीटर में HWID की एक सरणी या `"users"` पैरामीटर में उपयोगकर्ता आईडी पास करके सीधे विशिष्ट उपकरणों या उपयोगकर्ताओं को भी लक्षित कर सकते हैं:

```json
"users": ["user_id_1", "user_id_2", ...],
"hwids": ["hwid_1", "hwid_2", ...]
```
</Aside>

6. यदि आपने प्लेसहोल्डर सेट अप किए हैं, तो उनके मान के रूप में वांछित सामग्री निर्दिष्ट करें:

<img src="/journey-elements-api-based-entry-6.webp" alt="जर्नी लॉन्च करने के लिए API अनुरोध में प्लेसहोल्डर मान निर्दिष्ट करें"/>


7. यदि आप अपने अभियान को बार-बार पुनरारंभ करने की योजना बनाते हैं और नहीं चाहते कि वही उपयोगकर्ता कई बार जर्नी में प्रवेश करें, तो [अभियान प्रवेश सीमाएं](/hi/product/customer-journey/journey-settings#campaign-entry-limit) सेट करें।

> उदाहरण के लिए, आपने एक विशिष्ट उत्पाद के लिए मूल्य में कमी के बारे में उपयोगकर्ताओं को सूचित करने के लिए एक अभियान बनाया है। आप विभिन्न ऑडियंस फ़िल्टर के साथ कई अनुरोध भेजकर जर्नी को कुछ बार फिर से लॉन्च करना चाहते हैं। इस मामले में, आप अभियान प्रवेश सीमाएं जोड़ सकते हैं ताकि उन उपयोगकर्ताओं को बार-बार अधिसूचना न भेजी जाए जो कई फ़िल्टर से मेल खाते हैं।

8. यदि आप चाहते हैं कि जब भी कोई निश्चित व्यावसायिक इवेंट हो तो एक जर्नी लॉन्च हो, तो वेबहूक का उपयोग करके अनुरोध को स्वचालित करें। एक बार इवेंट होने पर, वेबहूक को जर्नी शुरू करने के लिए स्वचालित रूप से अनुरोध भेजना चाहिए।

यदि आपको स्वचालन की आवश्यकता नहीं है तो आप अनुरोध को मैन्युअल रूप से भी भेज सकते हैं।

<Aside type="note">
* यदि आप एक नया अनुरोध भेजते समय सेगमेंटेशन शर्तों को बदलते हैं, तो यह उन उपयोगकर्ताओं को प्रभावित नहीं करेगा जो पहले ही जर्नी में प्रवेश कर चुके हैं।
* यदि आप एक नया अनुरोध भेजते समय संदेश सामग्री को बदलते हैं, तो सभी उपयोगकर्ताओं को संदेश का नया संस्करण प्राप्त होगा (उन लोगों सहित जो पहले ही जर्नी में प्रवेश कर चुके हैं लेकिन अभी तक यह संदेश प्राप्त नहीं किया है)।
</Aside>