API Integration for Business

Business Plan या Launch Plan एकीकरण का एक महत्वपूर्ण हिस्सा आपके उपयोगकर्ताओं या क्लाइंट्स के लिए Ayrshare में नए प्रोफ़ाइल खाते बनाना और आपके उपयोगकर्ताओं को सोशल लिंकिंग पेज के साथ अपने सोशल नेटवर्क्स को लिंक करने की अनुमति देना शामिल है। आपके प्रत्येक उपयोगकर्ता को एक Ayrshare user profile के रूप में सेट किया जाता है। एक user profile को प्रत्येक सोशल नेटवर्क से एक कनेक्शन मिलता है।

यह ग्राहकों को ऑनबोर्ड करने का मानक तरीका है। आपके उपयोगकर्ता अपने स्वयं के सोशल खातों को नीचे वर्णित व्हाइट-लेबल किए गए JWT URL कनेक्ट पेज के माध्यम से कनेक्ट करते हैं — वे कभी भी Ayrshare में लॉग इन नहीं करते हैं और कभी भी आपके डैशबोर्ड को नहीं छूते हैं। डैशबोर्ड आपकी आंतरिक टीम के लिए आरक्षित है (प्रोफ़ाइल्स बनाना और प्रबंधित करना, परीक्षण करना, और क्लाइंट की ओर से पोस्ट करना)।

एकीकरण वर्कफ़्लो

Ayrshare को अपने एप्लिकेशन में एकीकृत करने के लिए, आपको दो API कॉल्स करने होंगे:

अपने उपयोगकर्ता के लिए एक नया Ayrshare प्रोफ़ाइल बनाने के लिए Create Profiles endpoint कॉल करें।
एक JWT URL प्राप्त करने के लिए Generate JWT endpoint कॉल करें।

JWT URL आपके उपयोगकर्ता को सिंगल साइन-ऑन ऑथेंटिकेशन के माध्यम से सोशल लिंकिंग पेज तक सुरक्षित रूप से पहुँचने की अनुमति देता है। आप इस पेज को उपयोगकर्ताओं को उनके सोशल मीडिया खातों को कनेक्ट करने देने के लिए एक नए टैब, विंडो, या व्यू कंट्रोलर में प्रदर्शित करेंगे।

आपके उपयोगकर्ता द्वारा अपने सोशल मीडिया खातों को लिंक करने के बाद, आप API के माध्यम से पोस्ट प्रकाशित करने, एनालिटिक्स प्राप्त करने, और उनके खातों को प्रबंधित करने में सक्षम होंगे।

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

एक Ayrshare User Profile बनाएँ

API के साथ एक प्रोफ़ाइल बनाएँ

जब कोई नया उपयोगकर्ता आपके सिस्टम के साथ पंजीकरण करता है या जब आपका क्लाइंट आपके ऐप में सोशल नेटवर्क लिंक पर क्लिक करता है, तो /profiles/create-profile RESTful एंडपॉइंट को कॉल करके, या NPM या PyPi पैकेजेस का उपयोग करके एक नया Ayrshare प्रोफ़ाइल खाता बनाएँ।

Profiles

इस कॉल से आपके उपयोगकर्ता की PROFILE KEY लौटाई जाएगी। इस key का उपयोग आपके उपयोगकर्ता की ओर से पोस्ट करने और उनके खाते का प्रबंधन करने के लिए किया जाएगा। आपको इसे एक सुरक्षित स्थान पर संग्रहीत करना चाहिए।

डैशबोर्ड के साथ एक प्रोफ़ाइल बनाएँ (आंतरिक टीम)

आपकी आंतरिक टीम Developer Dashboard से सीधे User Profiles भी बना सकती है — परीक्षण, प्रोफ़ाइल को मैन्युअल रूप से ऑनबोर्ड करने, या एक-बारगी प्रशासन के लिए उपयोगी। यह एक टीम टूल है, ग्राहक-सामने वाला फ़्लो नहीं: आपके ग्राहकों को कभी भी डैशबोर्ड एक्सेस नहीं दिया जाता है और उन्हें हमेशा JWT URL कनेक्ट पेज के माध्यम से ऑनबोर्ड किया जाता है। प्रोडक्शन ऑनबोर्डिंग के लिए, API के साथ प्रोग्रामेटिक रूप से प्रोफ़ाइल्स बनाएँ ताकि प्रत्येक नए उपयोगकर्ता को स्वचालित रूप से प्रोविज़न किया जा सके।

Manage User Profiles in Dashboard

एकीकरण पैकेज

Business Plan या Launch Plan क्लाइंट के रूप में आपकी ऑनबोर्डिंग के दौरान, आपको एक व्यक्तिगत एकीकरण पैकेज प्राप्त हुआ जिसमें महत्वपूर्ण सेटअप और डोमेन जानकारी, उदाहरण एंडपॉइंट कॉल्स, और बहुत कुछ शामिल था। कृपया इस जानकारी के लिए अपने प्राथमिक खाता धारक से जाँच करें। आप डैशबोर्ड में API पेज में एकीकरण पैकेज को पुनः प्राप्त या रीसेट भी कर सकते हैं। पहले अपनी Primary Profile पर स्विच करना सुनिश्चित करें।

JWT प्रमाणीकरण के साथ Single Sign-On

Ayrshare आपके उपयोगकर्ता को प्रमाणित करने और सोशल लिंकिंग पेज पर Single Sign-On करने के लिए एक JWT (JSON Web Token) का उपयोग करता है। JWT डिजिटल रूप से हस्ताक्षरित जानकारी पास करने के लिए एक सुरक्षित तंत्र है और Ayrshare को आपको और आपके उपयोगकर्ता को प्रमाणित करने की अनुमति देता है।

एक JWT जनरेट करें

आपका ऐप आपकी API Key, उपयोगकर्ता Profile Key, और कुछ अन्य पैरामीटर से बना एक JWT बनाएगा। इसे आपकी 1024-बिट प्राइवेट key के साथ हस्ताक्षरित किया जाएगा।

JWT टोकन 5 मिनट के लिए मान्य है। लंबे एक्सपायर टाइम के लिए कृपया Max Pack देखें।

कृपया Ayrshare से टोकन और सोशल लिंकिंग URL बनवाने के लिए Generate JWT endpoint का उपयोग करें। सोशल लिंकिंग URL को एक नए टैब या विंडो में खोलें, जिससे आपके उपयोगकर्ता आसानी से अपने सोशल नेटवर्क्स को लिंक कर सकें।

JWT URL प्रत्येक ग्राहक के लिए अनुशंसित ऑनबोर्डिंग पथ है। आपके उपयोगकर्ता स्वयं प्रत्येक सोशल नेटवर्क के साथ सीधे प्रमाणित करते हैं — आप कभी भी उनके सोशल क्रेडेंशियल्स को एकत्र या संग्रहीत नहीं करते हैं। यदि आपकी टीम को परीक्षण के दौरान किसी खाते को मैन्युअल रूप से लिंक करने की आवश्यकता है, तो आप डैशबोर्ड से ऐसा कर सकते हैं, लेकिन यह एक आंतरिक सुविधा है और यह वह तरीका नहीं है जिससे ग्राहकों को ऑनबोर्ड किया जाना चाहिए।

Connect Accounts पेज को व्हाइट-लेबल करें

क्योंकि JWT URL द्वारा खोला गया कनेक्ट पेज ही एकमात्र Ayrshare इंटरफ़ेस है जिसे आपके उपयोगकर्ता कभी देखते हैं, आपको इसे अपने ब्रांड के रूप में ब्रांड करना चाहिए। अपना लोगो और कस्टम हेडर्स जोड़ें, चुनें कि कौन से सोशल नेटवर्क्स दिखाई देते हैं, पेज की भाषा सेट करें, और अपने स्वयं के सहायता लिंक का उपयोग करें — और Max Pack के साथ, एक पूर्ण कस्टम CSS फ़ाइल, favicon, पेज शीर्षक, और फ़ूटर लागू करें। इन विकल्पों को आपकी टीम द्वारा Primary Profile से एक बार कॉन्फ़िगर किया जाता है और आपके द्वारा जनरेट किए गए प्रत्येक JWT URL पर लागू होते हैं।

White-Label the Connect Accounts Page

कनेक्ट पेज के लिए प्रत्येक ब्रांडिंग और अनुकूलन विकल्प देखें।

प्रोफ़ाइल सेशन का स्वचालित लॉगआउट

सक्रिय प्रोफ़ाइल सेशन से स्वचालित रूप से कैसे लॉग आउट करेंयदि कोई प्रोफ़ाइल पहले से लॉग इन है, तो किसी भिन्न प्रोफ़ाइल का JWT भेजने से प्रोफ़ाइल्स नहीं बदलेगी। यह पहले से लॉग-इन उपयोगकर्ताओं के लिए अनुभव को तेज़ बनाने के लिए किया जाता है। परीक्षण करते समय, किसी भिन्न प्रोफ़ाइल के साथ SSO कॉल करने से पहले वर्तमान प्रोफ़ाइल से लॉग आउट करें। साइन-इन प्रोफ़ाइल्स तब तक साइन इन रहती हैं जब तक स्पष्ट रूप से लॉग आउट नहीं किया जाता।हालाँकि, यदि आपकी कोई व्यावसायिक आवश्यकता है, जैसे कि आपके उपयोगकर्ताओं के पास कई प्रोफ़ाइल्स हैं जिन्हें वे अक्सर एक्सेस करते हैं, या आप परीक्षण करना चाहते हैं, तो SSO URL में URL पैरामीटर शामिल करें:logout=trueउदाहरण के लिए:https://profile.ayrshare.com?domain=[domain id]&jwt=[jwt token]&logout=trueयह लॉगआउट करने के लिए बाध्य करता है और फिर नई प्रोफ़ाइल में लॉग इन करता है।लॉगआउट को स्वचालित रूप से जोड़ने के लिए कृपया Generate JWT endpoint भी देखें।चेतावनी: स्वचालित लॉगआउट का उपयोग करने से आपके उपयोगकर्ता के लिए प्रदर्शन में देरी होती है, इसलिए जब तक आपको इसकी आवश्यकता न हो, हम लॉगआउट को बाध्य न करने और इसे प्रोडक्शन में उपयोग न करने का सुझाव देते हैं।

सोशल लिंकिंग URL को खोलना और बंद करना

Social Accounts पेज में एक “Close” बटन है जो विंडो को बंद करता है और आपके उपयोगकर्ता को आपकी साइट पर वापस लौटाता है।

सोशल लिंकिंग URL खोलना

जब आप सोशल लिंकिंग URL खोलते हैं, तो हम एंकर href के बजाय JavaScript के window.open() फ़ंक्शन का उपयोग करने की अनुशंसा करते हैं। “Close” बटन विंडो को बंद करने के लिए JavaScript का उपयोग करता है, और अधिकांश ब्राउज़र्स केवल स्क्रिप्ट के माध्यम से खोली गई विंडोज़ को बंद करने की अनुमति देते हैं। आप अपनी वेबसाइट पर सोशल लिंकेज विंडो लॉन्च करने के लिए निम्नलिखित सैंपल कोड का उपयोग कर सकते हैं।

Window Open

<div onclick="window.open('https://profile.ayrshare.com?domain...', '_blank')">
  Link Social Networks
</div>

या

Window Open Function

<button onclick="openNewTabAndRedirect()">Open New Tab and Redirect</button>
<script>
  function openNewTabAndRedirect() {
    // Open a new tab
    var newTab = window.open("https://profile.ayrshare.com?domain...");

    // Optional: Focus on the new tab
    newTab.focus();
  }
</script>

आप “Close” बटन को नियंत्रित कर सकते हैं ताकि या तो सोशल लिंकिंग टैब को अपनी पसंद के पेज पर रीडायरेक्ट करे या मूल ओपनर टैब/विंडो को रीडायरेक्ट करे और सोशल लिंकिंग टैब को बंद करे। यह redirect पैरामीटर का उपयोग करके और रीडायरेक्ट URL के क्वेरी पैरामीटर्स में origin=true जोड़कर किया जा सकता है। अधिक विवरण के लिए कृपया Generate JWT endpoint देखें।

बंद करते समय रीडायरेक्ट करना

इसके अतिरिक्त, यदि आप चाहते हैं कि Close बटन आपके पेज पर वापस रीडायरेक्ट हो (अक्सर मोबाइल पर उपयोगी), तो redirect GET पैरामीटर को https से शुरू होने वाली URL encoded स्ट्रिंग के रूप में पास करें। अधिक विवरण के लिए कृपया Generate JWT endpoint parameters देखें।

JWT URL

https://profile.ayrshare.com?domain=[domain id]&jwt=[jwt token]&redirect=https%3A%2F%2Fmywebsite.com

रीडायरेक्ट उस प्रोफ़ाइल के लिए सेव किया जाएगा और बाद के SSO कॉल्स में उपयोग किया जाएगा भले ही redirect पैरामीटर पास न किया जाए। Close बटन को बंद करने पर वापस रीसेट करने के लिए, पैरामीटर redirect=null पास करें।

अधिक जानकारी

उपयोगकर्ता लिंकिंग या अनलिंकिंग सूचनाएँ

जब कोई उपयोगकर्ता सोशल नेटवर्क को लिंक या अनलिंक करता है, तो आप वेबहुक के माध्यम से एक सूचना प्राप्त कर सकते हैं। अधिक जानकारी के लिए कृपया Social Action Webhooks पेज देखें। आप एक उपयोगकर्ता प्रोफ़ाइल के लिए कनेक्ट किए गए सोशल नेटवर्क्स प्राप्त करने के लिए user endpoint का भी उपयोग कर सकते हैं।

सोशल खातों के कई सेट

अवलोकन

प्रत्येक User Profile में सोशल मीडिया खातों का एक सेट होता है और वह प्रत्येक सोशल नेटवर्क से एक कनेक्शन बना सकता है। यदि आपके उपयोगकर्ताओं या क्लाइंट्स के पास सोशल मीडिया खातों के कई सेट हैं, जैसे कि दो Facebook Pages, दो Instagram खाते, और दो YouTube चैनल्स, तो आप इन सोशल मीडिया खातों के कई सेटों को इन चरणों का पालन करके प्रबंधित कर सकते हैं:

कई User Profiles बनाएँ - अपने उपयोगकर्ता या क्लाइंट को प्रबंधित करने के लिए आवश्यक सोशल खातों के प्रत्येक सेट के लिए Ayrshare सिस्टम में अलग-अलग User Profiles बनाएँ।
अद्वितीय Profile Keys संग्रहीत करें - प्रत्येक User Profile का अपना अद्वितीय Profile Key होगा, जो create User Profile एंडपॉइंट से लौटाया जाता है।
अपनी प्रोफ़ाइल्स को लेबल करें - प्रत्येक User Profile को Title या tag करें ताकि यह स्पष्ट रूप से पहचाना जा सके कि वे किन सोशल मीडिया खातों से जुड़े हैं (उदाहरण के लिए, “Facebook Page A” और “Facebook Page B”)।
अपने डेटाबेस में मैप करें - अपने स्वयं के सिस्टम में, सभी प्रासंगिक Profile Keys को संबंधित उपयोगकर्ता या क्लाइंट से जोड़ें।
उपयुक्त Profile Key का उपयोग करें - किसी विशिष्ट सोशल खाते के लिए सामग्री पोस्ट करते समय या एनालिटिक्स प्राप्त करते समय, उस खाते से जुड़ी Profile Key का उपयोग करें। उदाहरण के लिए, Facebook Page A पर पोस्ट करने के लिए, Facebook Page A से कनेक्ट किए गए User Profile की Profile Key का उपयोग करें।

उदाहरण

आइए कई क्लाइंट खातों के लिए एक व्यावहारिक परिदृश्य पर विचार करें:

क्लाइंट: दो लोकेशन्स के साथ Joe’s Restaurant Chain

Joe को प्रत्येक रेस्तराँ लोकेशन के लिए अलग-अलग सोशल मीडिया खातों की आवश्यकता है: रेस्तराँ लोकेशन 1:

Facebook Page: “Joe’s Downtown Bistro”
Instagram: @joesdowntownbistro
LinkedIn: Joe’s Downtown Bistro business page

रेस्तराँ लोकेशन 2:

Facebook Page: “Joe’s Seaside Grill”
Instagram: @joesseasidegrill
LinkedIn: Joe’s Seaside Grill business page

कार्यान्वयन समाधान:

Ayrshare में दो अलग-अलग User Profiles बनाएँ:

User Profile 1: शीर्षक “Joe’s Downtown Bistro Accounts”
User Profile 2: शीर्षक “Joe’s Seaside Grill Accounts”

प्रत्येक प्रोफ़ाइल से उपयुक्त सोशल खातों को कनेक्ट करें:

Profile 1: Downtown Bistro Facebook, Instagram, और LinkedIn को लिंक करता है
Profile 2: Seaside Grill Facebook, Instagram, और LinkedIn को लिंक करता है

दोनों Profile Keys को अपने डेटाबेस में संग्रहीत करें, उन्हें Joe के खाते से जोड़ें:
Client: Joe's Restaurant Chain - Profile Key 1: abc123... (Downtown location) - Profile Key 2: xyz789... (Seaside location)
Downtown लोकेशन के लिए एक विशेष मेनू अपडेट पोस्ट करते समय, API कॉल्स में Profile Key 1 का उपयोग करें। Seaside लोकेशन पर seafood प्रमोशन के बारे में पोस्ट करते समय, Profile Key 2 का उपयोग करें।

कई User Profiles बनाकर, उन्हें उचित रूप से शीर्षक या टैग करके, और उन्हें अपने सिस्टम में एकल उपयोगकर्ता या क्लाइंट से जोड़कर, आप Ayrshare का उपयोग करके समान प्लेटफ़ॉर्म्स पर उनके कई सोशल मीडिया खातों को प्रबंधित कर सकते हैं। यह दृष्टिकोण प्रत्येक विशिष्ट खाते के लिए लक्षित पोस्टिंग और एनालिटिक्स प्राप्ति की अनुमति देता है।

अगले चरण

उपयोगकर्ता अनुभव के अधिक विवरण के लिए कृपया यहाँ देखें:

User Integration

एक बार जब आपका उपयोगकर्ता अपने सोशल मीडिया लिंक्स सेट अप कर लेता है, तो आप /post और /profile एंडपॉइंट्स का उपयोग करके उनकी ओर से पोस्ट करना शुरू कर सकेंगे।

Get Started

API Endpoints

Multiple Users

Dashboard

Additional

एकीकरण वर्कफ़्लो

एक Ayrshare User Profile बनाएँ

API के साथ एक प्रोफ़ाइल बनाएँ

Profiles

डैशबोर्ड के साथ एक प्रोफ़ाइल बनाएँ (आंतरिक टीम)

Manage User Profiles in Dashboard

एकीकरण पैकेज

JWT प्रमाणीकरण के साथ Single Sign-On

एक JWT जनरेट करें

Connect Accounts पेज को व्हाइट-लेबल करें

White-Label the Connect Accounts Page

प्रोफ़ाइल सेशन का स्वचालित लॉगआउट

सोशल लिंकिंग URL को खोलना और बंद करना

सोशल लिंकिंग URL खोलना

बंद करते समय रीडायरेक्ट करना

अधिक जानकारी

उपयोगकर्ता लिंकिंग या अनलिंकिंग सूचनाएँ

सोशल खातों के कई सेट

अवलोकन

उदाहरण

अगले चरण

User Integration

Post API

Profiles API

​एकीकरण वर्कफ़्लो

​एक Ayrshare User Profile बनाएँ

​API के साथ एक प्रोफ़ाइल बनाएँ

Profiles

​डैशबोर्ड के साथ एक प्रोफ़ाइल बनाएँ (आंतरिक टीम)

Manage User Profiles in Dashboard

​एकीकरण पैकेज

​JWT प्रमाणीकरण के साथ Single Sign-On

​एक JWT जनरेट करें

​Connect Accounts पेज को व्हाइट-लेबल करें

White-Label the Connect Accounts Page

​प्रोफ़ाइल सेशन का स्वचालित लॉगआउट

​सोशल लिंकिंग URL को खोलना और बंद करना

​सोशल लिंकिंग URL खोलना

​बंद करते समय रीडायरेक्ट करना

​अधिक जानकारी

​उपयोगकर्ता लिंकिंग या अनलिंकिंग सूचनाएँ

​सोशल खातों के कई सेट

​अवलोकन

​उदाहरण

​अगले चरण

User Integration

Post API

Profiles API

एकीकरण वर्कफ़्लो

एक Ayrshare User Profile बनाएँ

API के साथ एक प्रोफ़ाइल बनाएँ

डैशबोर्ड के साथ एक प्रोफ़ाइल बनाएँ (आंतरिक टीम)

एकीकरण पैकेज

JWT प्रमाणीकरण के साथ Single Sign-On

एक JWT जनरेट करें

Connect Accounts पेज को व्हाइट-लेबल करें

प्रोफ़ाइल सेशन का स्वचालित लॉगआउट

सोशल लिंकिंग URL को खोलना और बंद करना

सोशल लिंकिंग URL खोलना

बंद करते समय रीडायरेक्ट करना

अधिक जानकारी

उपयोगकर्ता लिंकिंग या अनलिंकिंग सूचनाएँ

सोशल खातों के कई सेट

अवलोकन

उदाहरण

अगले चरण