ईबे एपीआई: पहले चरण

जैसा कि आप जानते हैं, कुछ सीखना शुरू करना सबसे मुश्किल है, ईबे एपीआई, भले ही इसका सामान्य दस्तावेज हो, कोई अपवाद नहीं है। मैं खुद अभी हाल ही में इसका अध्ययन करना शुरू किया और वांछित चित्र मेरे सिर में आकार लेने से पहले डॉक और तीसरे पक्ष के संसाधनों पर कसकर चढ़ना पड़ा।

यह पोस्ट उन लोगों के लिए है, जिन्हें ईबे एपीआई के साथ और खुद के लिए जल्दी से काम करना शुरू करना है, ताकि भविष्य में कुछ भी न भूलें।

क्विक स्टार्ट गाइड

मूल रूप से, ईबे में एक तथाकथित " क्विक स्टार्ट गाइड " है, तो आइए पहले इसके माध्यम से जाएं:

1. एक नए डेवलपर का पंजीकरण - एपीआई के सभी अनुरोधों को कुछ अद्वितीय डेवलपर मापदंडों के हस्तांतरण के साथ किया जाता है। उन्हें कैसे प्राप्त करें, दूसरा पैराग्राफ पढ़ें;



2. developer.ebay.com पर सफलतापूर्वक पंजीकरण और लॉग इन करने के बाद, आप "एप्लिकेशन कीज़" बनाना शुरू कर सकते हैं, जिसे आपको अपने एपीआई अनुरोधों को पूरा करने की आवश्यकता होगी। ऐसा करने के लिए, " मेरा खाता " अनुभाग पर जाएं और "एप्लिकेशन कुंजी" ब्लॉक में हम कुंजी के 2 सेट उत्पन्न करते हैं:

2.1 सैंडबॉक्स कीज़ - परीक्षण एपीआई के अनुरोधों के लिए कुंजी;

2.2 उत्पादन कुंजी - कार्यशील एपीआई के लिए अनुरोधों की कुंजी।



3. यह पैराग्राफ " नमूना अनुप्रयोग " का एक लिंक देता है, जिसके साथ आप किसी एक प्रकार के एपीआई के लिए अनुरोधों का परीक्षण कर सकते हैं (हां, जैसा कि यह पता चला है कि कई हैं :)) "फाइंडिंग एपीआई" (मैं नीचे एपीआई के मुख्य प्रकारों के बारे में अधिक लिखूंगा)। इस "नमूना आवेदन" के पृष्ठ पर 3 ब्लॉक हैं:

3.1 नमूना अनुप्रयोग स्रोत कोड - इसमें HTML / JS कोड होता है, जिसके सबसे नीचे एक JS lib जुड़ा होता है, वह URL जिसमें "खोज API" URL आवश्यक पैरामीटर पहले से सेट है;

3.2 पार्स नमूना नमूना - इसमें HTML पृष्ठ के रूप में क्वेरी का परिणाम होता है;

3.3 कॉल रिस्पांस - इसमें XML के रूप में अनुरोध का परिणाम होता है।



4. प्रोग्रामिंग भाषा द्वारा समूहीकृत डेवलपर्स के वर्गों के लिए लिंक।

उत्पाद एपीआई

1. ढूँढना एपीआई - ईबे उत्पादों की एक सूची प्राप्त करने के लिए डिज़ाइन किया गया। यह एपीआई निम्नलिखित मानदंडों द्वारा उत्पादों की खोज करने की क्षमता प्रदान करता है:

1.1 findItemsByCategory - श्रेणी के आधार पर उत्पादों की खोज;

1.2 findItemsByKeywords - कीवर्ड द्वारा उत्पादों की खोज;

1.3 findItemsAdvanced - आप श्रेणियों और कीवर्ड के लिए एक मिश्रित खोज बनाने के लिए अनुमति देता है;

1.4 findItemsByProduct - उत्पाद पहचानकर्ताओं द्वारा उत्पादों की खोज। उत्पादों में शामिल हो सकते हैं, उदाहरण के लिए: फोन, वीडियो गेम, किताबें, आदि।



2. शॉपिंग एपीआई - मुख्य रूप से उत्पाद के बारे में विस्तृत जानकारी प्राप्त करने के लिए। किसी उत्पाद के बारे में कोई भी जानकारी प्राप्त करने के लिए, आपको उसकी आईडी जानने की आवश्यकता होती है, जिसे खोजे गए एपीआई के अनुरोध के जवाब में पाया गया उत्पादों की सूची से प्राप्त किया जा सकता है। यह एपीआई आपको निम्नलिखित प्रश्नों को निष्पादित करने की अनुमति देता है:

2.1 GetSingleItem - अपनी आईडी द्वारा एक उत्पाद के बारे में सभी सार्वजनिक जानकारी देता है;

2.2 GetItemStatus - माल की वर्तमान दरों के बारे में जानकारी देता है, उसी समय आप 10 उत्पादों के बारे में जानकारी का अनुरोध कर सकते हैं;

2.3 GetShippingCosts - आप खरीदार को माल की डिलीवरी की लागत की गणना करने की अनुमति देते हैं। गणना के लिए, आपको उत्पाद आईडी, देश के उस कोड को स्थानांतरित करना होगा जहां डिलीवरी की जाएगी, खरीदार का डाक कोड और माल की इकाइयों की संख्या जो खरीदे / खरीदे जाएंगे। इस अनुरोध को पूरा करने से पहले, आपको पहले यह सुनिश्चित करने की आवश्यकता है कि उत्पाद का शिपिंग मूल्य है;

2.4 GetMultipleItems GetSingleItem के समान है, लेकिन आप एक साथ कई उत्पादों (अधिकतम 20 उत्पादों) के बारे में जानकारी का अनुरोध कर सकते हैं।

एपीआई ढूँढना

सरल उदाहरण के आधार पर इस एप के साथ काम करने पर विचार करें। मैंने XML के माध्यम से एपीआई के साथ संचार करने के लिए प्रारूप चुना, मैं पोस्ट विधि का उपयोग करके एपीआई को अनुरोध भेज रहा हूं। लेकिन पहले, मैं आवश्यक मापदंडों को सूचीबद्ध करूंगा:



1. X-EBAY-SOA-OPERATION-NAME - इस पैरामीटर का मान उस क्रिया का नाम होना चाहिए जिसका आप प्रदर्शन करने वाले हैं। उदाहरण के लिए: findItemsByKeywords, findItemsByCategory;



2. X-EBAY-SOA-SECURITY-APPNAME - इस पैरामीटर में आपको अपना AppID स्थानापन्न करने की आवश्यकता है, जो " मेरा खाता " अनुभाग में पाया / उत्पन्न किया जा सकता है।



POST विधि का उपयोग करते समय इन दोनों मापदंडों को अनुरोध शीर्षक में पारित किया जाना चाहिए। आप एक एपीआई कॉल पेज बनाने पर एपीआई खोजने के लिए सामान्य मापदंडों के बारे में अधिक पढ़ सकते हैं।



अब "findItemsByKeywords" कार्रवाई का उपयोग करके उत्पाद खोज का एक उदाहरण देखें।



// Get entity of http client

$httpClient = new Http_Client('http://svcs.sandbox.ebay.com/services/search/FindingService/' . FINDING_API_VERSION);



// Prepare headers

$httpClient->setHeaders(

array(

'X-EBAY-SOA-OPERATION-NAME: findItemsByKeywords',

'X-EBAY-SOA-SECURITY-APPNAME: ' . APP_ID

)

);



// Prepare body

$httpClient->setBody(

'<?xml version="1.0" encoding="utf-8"?>

<findItemsByKeywordsRequest xmlns="http://www.ebay.com/marketplace/search/v1/services">

<keywords>' . htmlspecialchars($keywords) . '</keywords>

<paginationInput>

<entriesPerPage>10</entriesPerPage>

</paginationInput>

</findItemsByKeywordsRequest>'

);



// Send request

$result = $httpClient->send();









जहां:

1. Http_Client - CURL का उपयोग करके एपीआई को अनुरोध भेजने के लिए मेरा छोटा वर्ग। यह कोड संग्रह में है;



2. अनुरोध URL इस तरह दिखाई देगा: svcs.sandbox.ebay.com/services/search/FindingService/v1 , लेकिन जब से डॉक कहता है कि "v1" (एपीआई संस्करण) बदल सकता है, मैंने इसे एक स्थिरांक में डाल दिया;



3. सेटहेडर्स () विधि अनुरोध हेडर सेट करती है। लगातार APP_ID मेरे AppID को संग्रहीत करता है;



4. सेट बॉडी () विधि अनुरोध निकाय सेट करती है। हम जिस कीवर्ड टैग से कीवर्ड पास करते हैं, उसका अनुमान लगाना मुश्किल नहीं है। एंट्रीपर्सपेज पैरामीटर एपीआई से कहता है कि हमें 10 उत्पादों को वापस करने की आवश्यकता है (और findItemsByKeywords एक्शन पैरामीटर के बारे में यहां पाया जा सकता है );



5. खैर, भेजने () विधि एपीआई के लिए एक अनुरोध भेजता है और अपनी प्रतिक्रिया देता है, जिसे XML के रूप में $ परिणाम चर में रखा जाएगा।

शॉपिंग एपीआई

मैं GetSingleItem शॉपिंग एपीआई एक्शन अनुरोधों का उपयोग करके विस्तारित उत्पाद जानकारी देखने की क्षमता के साथ अपने छोटे अनुप्रयोग को पूरक करूंगा। सबसे पहले, मैं आवश्यक मापदंडों की सूची दूंगा:



1. एक्स-ईबे-एपीआई-कॉल-नाम - पैरामीटर खरीदारी एपीआई के भीतर कार्रवाई का नाम सेट करता है। उदाहरण के लिए: GetSingleItem, GetItemStatus;



2. X-EBAY-API-APP-ID - पैरामीटर आपके AppID को पास करता है;



3. X-EBAY-API-REQUEST-ENCODING - एपीआई के लिए अनुरोध प्रारूप। POST विधि के लिए, आपको "XML" निर्दिष्ट करना होगा;



4. एक्स-ईबे-एपीआई-संस्करण - एपी संस्करण जो आपके आवेदन का समर्थन करता है। परीक्षणों के लिए, मैंने 699 का संकेत दिया।



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



यहां मेरा संक्षिप्त कोड है जो विस्तृत उत्पाद जानकारी के लिए पूछता है:



// Get entity of http client

$httpClient = new Http_Client('http://open.api.sandbox.ebay.com/shopping');



// Prepare headers

$httpClient->setHeaders(

array(

'X-EBAY-API-CALL-NAME: GetSingleItem',

'X-EBAY-API-APP-ID: ' . APP_ID,

'X-EBAY-API-REQUEST-ENCODING: ' . SHOPPING_API_DATA_FORMAT,

'X-EBAY-API-VERSION: ' . SHOPPING_API_VERSION

)

);



// Prepare body

$httpClient->setBody(

'<?xml version="1.0" encoding="utf-8"?>

<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">

<ItemID>' . $id . '</ItemID>

<IncludeSelector>TextDescription</IncludeSelector>

</GetSingleItemRequest>'

);



// Send request

$result = $httpClient->send();









यहां, पिछले उदाहरण की तरह, मैंने शॉपिंग एपीआई परीक्षण क्षेत्र के लिए URL सेट किया, यह " open.api.sandbox.ebay.com/shopping " होगा। फिर मैं हेडर की एक सरणी और एक अनुरोध निकाय बनाता हूं। अनुरोध निकाय में, मैंने आइटम पहचान में उत्पाद पहचानकर्ता को संकेत दिया (वैसे, मैं इसे अंतरंग करने की अनुशंसा नहीं करता हूं, क्योंकि ईबे पर उत्पाद आईडी का आकार लंबे समय से अधिक हो गया है) और अतिरिक्त डेटा के रूप में मैंने अनुरोध किया TextDescription (उत्पाद का एक पाठ विवरण, अधिक के बारे में) GetSingleItem कार्रवाई के सभी मापदंडों को यहां पढ़ा जा सकता है )।

कुल मिलाकर

मुझे उम्मीद है कि यह पोस्ट किसी को ईबे एपीआई के साथ परिचित करने के लिए समय कम करने की अनुमति देगा।



मेरे परीक्षण आवेदन का संग्रह

सभी एपीआई के लिए URL सूची पृष्ठ