यूआरएल शॉर्टनर एपीआई: अपने ऐप में शॉर्ट लिंक को स्वचालित करें

हाथ से लिंक बनाना ठीक है जब तक कि यह ठीक न हो। जिस क्षण हर ऑर्डर को एक ट्रैकिंग लिंक की आवश्यकता होती है, हर उपयोगकर्ता को एक रेफरल लिंक की आवश्यकता होती है, या हर लिस्टिंग को एक क्यूआर कोड की आवश्यकता होती है, आपको प्रोग्रामेटिक रूप से वही चीज़ चाहिए। यही एक यूआरएल शॉर्टनर एपीआई के लिए है — और यह इतना छोटा है कि आप इसे कॉफी के दौरान सेट कर सकते हैं।

आप क्या स्वचालित कर सकते हैं

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

यदि आप सुनिश्चित नहीं हैं कि आपको अभी एपीआई की आवश्यकता है, तो ईमानदार परीक्षण मात्रा और पुनरावृत्ति है: यदि आप सप्ताह में एक से अधिक बार ब्राउज़र में वही काम कर रहे हैं, तो इसे स्वचालित करें।

प्रमाणित करें

अपने खाते के पृष्ठ से अपनी कुंजी प्राप्त करें और इसे हर अनुरोध पर एक X-Api-Key हेडर के रूप में भेजें। दो नियम जो बातचीत के लिए नहीं हैं: कुंजी को सर्वर-साइड रखें — फ्रंट-एंड जावास्क्रिप्ट में कुछ भी सार्वजनिक है, और एक लीक हुई कुंजी अजनबियों को आपके नाम पर लिंक बनाने देती है — और यदि यह कभी भी एक रिपॉजिटरी या लॉग में आती है तो तुरंत इसे घुमाएं।

एक लिंक बनाएं

एक POST को /api/getLink.json के साथ गंतव्य के साथ। आप उसी कॉल में एक उपनाम, एक मोड, एक समाप्ति और एक पासवर्ड पास कर सकते हैं:

curl -X POST https://urlik.app/api/getLink.json -H "X-Api-Key: YOUR_KEY" -d "url=https://example.com/very/long/path" -d "alias=spring-sale"

प्रतिक्रिया JSON है जिसमें शॉर्ट यूआरएल, इसका क्यूआर यूआरएल और इसका आंकड़े यूआरएल शामिल है। एक कुंजी के साथ बनाए गए लिंक आपके खाते से जुड़े होते हैं, इसलिए वे आपके डैशबोर्ड में दिखाई देते हैं और बाद में संपादित किए जा सकते हैं।

बनाने से पहले जानने के लिए एक विवरण: एक उपनाम सेवा में अद्वितीय है। यदि spring-sale लिया गया है तो आपको एक त्रुटि मिलेगी, चुप्पी से गिरने के बजाय — इसलिए या तो उस मामले को संभालें या अपने उपनामों को नामस्थान दें (acme-spring-sale)।

क्यूआर कोड उत्पन्न करें

GET /api/qr.json डेटा लेता है साथ ही वैकल्पिक फॉर्मेट, fg, bg, ecc और साइज, और क्यूआर लौटाता है। इसे एक शॉर्ट लिंक पर इंगित करें न कि एक कच्चे लंबे यूआरएल पर — आपको एक साफ, मजबूत कोड मिलता है, और गंतव्य बाद में संपादित रहता है। यही गतिशील क्यूआर कोड पैटर्न है, जो आपके बैकएंड से किया गया है।

आंकड़े पढ़ें

GET /api/stats.json कुल, एक समय श्रृंखला, रेफरर्स, उपकरण और देशों के लिए एक लिंक लौटाता है — वही आंकड़े जो आंकड़े पृष्ठ पर हैं, एक रूप में जिसे आप अपने स्वयं के प्रशासन पैनल में डाल सकते हैं।

इसे एक शेड्यूल पर पोल करें, हर पृष्ठ लोड पर नहीं। क्लिक आंकड़े वास्तविक समय के रिकॉर्ड सिस्टम नहीं हैं, और एक चार्ट को फिर से खींचने के लिए एंडपॉइंट को हिट करना जो कोई नहीं देख रहा है, यही वह तरीका है जिससे आप दर सीमा से मिलते हैं।

इसे इस तरह बनाएं कि यह 3 बजे न टूटे

एंडपॉइंट सरल हैं; जो एकीकरण विफल होते हैं वे हैं जो मानते हैं कि कुछ भी गलत नहीं होता। चार आदतें जो अपने लिए भुगतान करती हैं:

• प्रतिक्रिया की जांच करें, हमेशा। हर कॉल एक स्थिति लौटाती है — इसे पढ़ें। क्लासिक बग यह मान लेना है कि सफलता है और एक त्रुटि बॉडी को एक शॉर्ट लिंक के रूप में संग्रहीत करना, फिर इसे एक प्रिंटेड चालान पर खोजने के लिए।
• कभी भी उपयोगकर्ता को एक लिंक पर ब्लॉक न करें। यदि संक्षिप्तता चेकआउट के अंदर होती है, तो एक धीमी एपीआई एक धीमी चेकआउट बन जाती है। इसे एक बैकग्राउंड जॉब में करें, या लंबे यूआरएल पर वापस जाएं और बाद में पुनः प्रयास करें। लंबा यूआरएल हमेशा काम करता है; यही आपका सुरक्षा जाल है।
• जो नहीं बदलता है उसे कैश करें। वही गंतव्य दो बार संक्षिप्त करने की आवश्यकता नहीं है — स्रोत रिकॉर्ड के खिलाफ शॉर्ट यूआरएल को स्टोर करें और इसका पुन: उपयोग करें। सस्ता, तेज, और आपका डैशबोर्ड पढ़ने योग्य रहता है।
• त्रुटियों पर पीछे हटें। एक तंग लूप में नहीं, बल्कि बढ़ती देरी के साथ पुनः प्रयास करें। एक दर सीमा के साथ उत्तर दिया गया एक पुनः प्रयास तूफान एक दर सीमा बना रहता है।

जहां एपीआई रुकता है

दो ईमानदार सीमाएँ। दर सीमाएँ मौजूद हैं और उदार अनंत नहीं है — बैच कार्यों को गति दी जानी चाहिए, एक साथ नहीं। और एपीआई लिंक बनाता है; यह यह तय नहीं करता कि उनमें क्या होना चाहिए। अपने लिंक को निर्माण के समय UTM पैरामीटर के साथ टैग करें (देखें UTM गाइड) या आप हजारों लिंक के उत्पादन को स्वचालित करेंगे जिन्हें आप विश्लेषण में अलग नहीं कर सकते — जो हाथ से करने की तुलना में एक बुरा स्थिति है।

संक्षिप्त संस्करण

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