{
"ok": true,
"data": {
"url": "https://github.com",
"final_url": "https://github.com",
"status_code": 200,
"title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
"description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
"image": "https://images.ctfassets.net/8aevphvgewt8/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
"site_name": "GitHub",
"favicon": "https://github.com/fluidicon.png",
"canonical": "https://github.com",
"type": "object",
"twitter_card": "summary_large_image",
"language": "en"
},
"meta": {
"request_id": "74494e4e82aa4879aa49a381209f3935",
"api": "link-preview",
"version": "1",
"elapsed_ms": 2177,
"llm_used": false,
"cache_hit": false,
"warnings": [],
"plan": null
}
}
curl --location --request GET 'https://zylalabs.com/api/15181/link+preview+unfurl+api/40591/preview+get?url=https://github.com' --header 'Authorization: Bearer YOUR_API_KEY'
{
"ok": true,
"data": {
"url": "https://github.com",
"final_url": "https://github.com",
"status_code": 200,
"title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
"description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
"image": "https://images.ctfassets.net/8aevphvgewt8/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
"site_name": "GitHub",
"favicon": "https://github.com/fluidicon.png",
"canonical": "https://github.com",
"type": "object",
"twitter_card": "summary_large_image",
"language": "en"
},
"meta": {
"request_id": "42b5e2c3a7ee46d9ad148a81bd46bc06",
"api": "link-preview",
"version": "1",
"elapsed_ms": 2616,
"llm_used": false,
"cache_hit": false,
"warnings": [],
"plan": null
}
}
curl --location --request POST 'https://zylalabs.com/api/15181/link+preview+unfurl+api/40592/preview+post' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"url":"https://github.com"}'
साइन अप करने के बाद, प्रत्येक डेवलपर को एक पर्सनल API एक्सेस की असाइन की जाती है, जो अक्षरों और अंकों का एक यूनिक संयोजन होता है, जिसका उपयोग हमारे API एंडपॉइंट तक पहुंचने के लिए किया जाता है। प्रमाणीकरण के लिए लिंक पूर्वावलोकन विस्तार API के साथ बस अपने बेयरर टोकन को Authorization हेडर में शामिल करें।
| हेडर | विवरण |
|---|---|
Authorization
|
आवश्यक
होना चाहिए Bearer access_key. जब आप सब्सक्राइब हों तो ऊपर "Your API Access Key" देखें।
|
कोई लंबी अवधि की प्रतिबद्धता नहीं। कभी भी अपग्रेड, डाउनग्रेड या कैंसल करें। फ्री ट्रायल में 50 रिक्वेस्ट तक शामिल हैं।
एक URL को Open Graph और Twitter Card मेटाडेटा तथा एक फ़ेविकॉन में विस्तृत करें। स्क्रीनशॉट कैप्चर अभी उपलब्ध नहीं है; मेटाडेटा प्रीव्यू पूरी तरह समर्थित हैं
यह शीर्षक विवरण छवि साइट का नाम फ़ेविकॉन कैनॉनिकल यूआरएल और कार्ड प्रकार लौटाता है जो कोई चैट ऐप या सीएमएस किसी लिंक के नीचे दिखाता है
यह पहले Open Graph और Twitter Card टैग पढ़ता है, फिर HTML शीर्षक और मेटा विवरण पर निर्भर करता है
स्क्रीनशॉट कैप्चर वर्तमान में उपलब्ध नहीं है; मेटाडेटा पूर्वावलोकन पूरी तरह समर्थित हैं
पृष्ठ प्राप्त किए जाने से पहले निजी होस्ट, मेटाडेटा पते और गैर-वेब पोर्ट अस्वीकार कर दिए जाते हैं
अपने X-Api-Key हेडर के साथ GET /v1/preview?url=https://github.com/ भेजें JSON प्रतिक्रिया में पेज का मेटाडेटा और फ़ेविकॉन शामिल हैं
यह चैट ऐप्स CMS एडिटर और ऐसे किसी भी उत्पाद के लिए बनाया गया है जिसे पेस्ट किए गए लिंक के नीचे एक समृद्ध कार्ड दिखाना हो
दोनों एंडपॉइंट लिंक का मेटाडेटा लौटाते हैं GET एंडपॉइंट लक्ष्य URL को क्वेरी पैरामीटर के रूप में प्राप्त करता है जबकि POST एंडपॉइंट URL को JSON अनुरोध बॉडी में प्राप्त करता है उनके पूर्वावलोकन डेटा में एक ही सामान्य प्रतिक्रिया संरचना का उपयोग होता है
डेटा ऑब्जेक्ट में अनुरोधित URL अंतिम URL HTTP स्थिति कोड शीर्षक विवरण छवि साइट का नाम फ़ेविकॉन कैननिकल URL सामग्री प्रकार Twitter Card मान और भाषा शामिल हो सकते हैं
Final_url वह URL है जिस पर रीडायरेक्ट या अन्य नेविगेशन बदलावों के बाद पहुँचा जाता है। इसकी तुलना url से करें ताकि पता चल सके कि मूल पता किसी दूसरे पेज पर रीडायरेक्ट हुआ था या नहीं
Canonical में उपलब्ध होने पर पृष्ठ का घोषित पसंदीदा URL होता है भाषा पहचानी गई या घोषित पृष्ठ भाषा की पहचान करती है, जैसे "en", जिससे अनुप्रयोगों को पूर्वावलोकनों को उचित रूप से लेबल करने या संसाधित करने में मदद मिलती है
पहले शीर्ष-स्तरीय ok फ़ील्ड जाँचें सफल होने पर पूर्वावलोकन के लिए data और प्राप्त किए गए पृष्ठ के HTTP परिणाम के लिए status_code का उपयोग करें गुम मानों के लिए फ़ील्ड भी जाँचें क्योंकि अलग-अलग पृष्ठों में हर मेटाडेटा तत्व उपलब्ध नहीं हो सकता
मेटा ऑब्जेक्ट में अनुरोध निदान संबंधी जानकारी होती है जैसे request_id, API नाम, संस्करण, elapsed_ms और अन्य प्रोसेसिंग मेटाडेटा। किसी प्रतिक्रिया को लॉग या सहायता संबंधी जांच से जोड़ने के लिए request_id का उपयोग करें
प्रतिक्रिया में image, site_name, favicon, canonical या twitter_card जैसे फ़ील्ड के मान खाली या अनुपस्थित हो सकते हैं। एप्लिकेशन को इन फ़ील्ड को वैकल्पिक मानना चाहिए और उपलब्ध शीर्षक, विवरण तथा URL का उपयोग करके सरल रूप में दिखाना चाहिए
छवि को मुख्य रिच-पूर्वावलोकन कलाकृति और फ़ेविकॉन को साइट आइकन के रूप में उपयोग करें दोनों URL के रूप में लौटाए जाते हैं, इसलिए क्लाइंट कार्ड या सूचियों में उन्हें दिखा सकते हैं और अनुपस्थित, अप्राप्य या अनुपयुक्त संपत्तियों को सहजता से संभाल सकते हैं