REST API Prestashop को समझना

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

स्टोर में REST इंटरफ़ेस का सक्रियण

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

मूल अवधारणा

स्टोर के साथ संचार पूरी तरह से XML में होता है, केवल तस्वीर अपलोड करने के मामले को छोड़कर, जिस पर हम नीचे विचार करेंगे। एपीआई सिस्टम CRUD (क्रिएट, रीड, अपडेट, डिलीट) के सिद्धांत पर बनाया गया है, जिसे जब HTTP अनुरोध भाषा में अनुवादित किया जाता है, तो यह हमें निम्नलिखित देता है:

स्टोर के साथ अधिकांश संचार PSWebServiceLibrary वर्ग के माध्यम से समुदाय के सदस्यों में से एक द्वारा लिखा जाएगा। आप इसे लिंक से डाउनलोड कर सकते हैं, या प्रलेखन पृष्ठों पर पा सकते हैं।
सभी संभावित तरीकों की सूची, और चर के प्रकारों की एक व्याख्या यहाँ doc.prestashop.com है , वास्तव में यह सभी प्रलेखन से सबसे आवश्यक दस्तावेज है, हालांकि, लिंक yoursite.ru/api/ पर क्लिक करके और लॉगिन के रूप में पहले से बनाई गई एक्सेस कुंजी दर्ज करके, आप लिंक से मिलते जुलते संकेत दे सकते हैं। "xlink: href" विशेषता में, और नेत्रहीन एपीआई की संरचना देखें।

तत्वों का निर्माण

स्टोर की संरचना के किसी भी तत्व को बनाने के लिए (हम उत्पाद को एक उदाहरण के रूप में लेते हैं), हमें पहले एक XML दस्तावेज़ रिक्त प्राप्त करने की आवश्यकता है। ऐसा करने के लिए, उत्पाद सूची लिंक में स्कीमा = सिनोप्सिस जोड़ें। निम्नलिखित PSWebServiceLibrary वर्ग के माध्यम से एक आइटम बनाने का एक उदाहरण है:

//    url        $webService = new PrestaShopWebservice($shop_url, $secret_key, $debug); // ,  products  ?schema=synopsis    $xml_product = $webService->get(array('resource' => 'products?schema=synopsis')); //     XML $resources_product = $new_product->children()->children(); $resources_product->name->language[0][0] = "Test product"; $resources_product->link_rewrite->language[0][0] = "tstproduct"; $resources_product->active = 1; $resources_product->available_for_order = 1; $resources_product->show_price = 1; $resources_product->out_of_stock = 2;//    ,    //   ,      ,   $resources_product->associations->categories->category[0]->id = 1; //     $created_product = $webService->add(array('resource' => 'products', 'postXml' => $new_product->asXML())); 

चर $ create_product में, हमारे पास सफलता के मामले में XML उत्पाद कार्ड या त्रुटि के विवरण वाला कार्ड है। यह कथन चित्रों के अलावा किसी भी तत्व को बनाने के लिए सही है।
यदि आप डिबग आउटपुट को देखते हैं, तो आप देख सकते हैं कि वर्ग GET विधि का उपयोग करते हुए पते yoursite.ru/api/products/?schema=synopsis पर वर्कपीस के पीछे क्रॉल कर रहा है और आपका iteite / api / products/ पर POST विधि का उपयोग करके सामान जोड़ता है।

चित्र बनाएँ

दुर्भाग्य से, PSWebServiceLibrary वर्ग में चित्रों को लोड करने के लिए कोई तैयार विधि नहीं है, इसलिए मुझे अपनी चाल चलनी पड़ी। अच्छे के लिए, इसे पूर्वोक्त वर्ग में पेश करना आवश्यक होगा, लेकिन न तो ताकत थी और न ही समय। इसलिए, हम स्वयं चित्र अपलोड करेंगे। इसके अलावा, छवियों को डाउनलोड करने के लिए URL सिर्फ सामानों (/ एपीआई / उत्पादों /) के मामले में / एपीआई / छवियां / उदाहरण के लिए नहीं है, लेकिन अगर यह एक उत्पाद चित्र, / एपीआई / चित्र / उत्पाद / $ product_id / है। इस सुविधा की पहचान प्रायोगिक तौर पर की गई थी।
उत्पाद छवि डाउनलोड कोड:

 $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $shop_url."api/images/products/".$product_id."/"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_USERPWD, $secret_key.":"); curl_setopt($ch, CURLOPT_TIMEOUT, 60); curl_setopt($ch, CURLOPT_POSTFIELDS, array('image' => '@my_image.png')); $response= curl_exec($ch); 

$ प्रतिसाद चर में, हम या तो उस चित्र के साथ समाप्त हो जाएंगे जिसे हमने अपलोड किया था, या एक एक्सएमएल त्रुटि कार्ड। यहां आपको सर्वर रिस्पांस कोड या रिस्पॉन्स टेक्स्ट को चेक करके लोडिंग एरर की जांच करनी होगी।
यह ध्यान दिया जाना चाहिए कि डाउनलोड की गई छवि की आईडी प्राप्त करना असंभव है, इसके लिए मैंने तुरंत छवि लोड करने के बाद निर्दिष्ट उत्पाद (/ एपीआई / चित्र / उत्पाद / $ product_id /) के सभी छवियों का चयन किया और उच्चतम आईडी वाला हमारा है।

तत्वों का संपादन

एडिटिंग बनाने के दौरान बहुत कुछ उसी तरह से होता है, सिवाय इसके कि शुरुआत में हमें प्रोडक्ट के लिए ब्लैंक कार्ड नहीं, बल्कि प्रोडक्ट ही मिलता है। खेतों को संशोधित करने के बाद, हम बस उसी मापदंडों के साथ जोड़ने के लिए PSWebServiceLibrary वर्ग की विधि को एड से बदलते हैं।

 $product = $webService->get(array('resource' => 'products', 'id' => $product_id)); $mod_product = $webService->edit(array('resource' => 'products', 'id' => $product_id, 'putXml' => $product->asXML())); 

आइटम हटाएं

हटाए जाने की विधि के समान वाक्यविन्यास का उपयोग करते हुए विलोपन होता है, लेकिन केवल हटाने की विधि का उपयोग करके

 $webService->delete(array('resource' => 'products', 'id' => $product_id)); 

जवाब में कुछ भी नहीं लौटाया जाएगा।

कैचिंग एरर

यदि हम PSWebServiceLibrary क्लास का उपयोग करते हैं, तो इसके तरीकों के लिए प्रत्येक कॉल को एक कोशिश में लपेटा जाना चाहिए ... पकड़ ब्लॉक, क्योंकि यदि कोई सर्वर विफल रहता है, तो यह PrestaShopWebserviceException प्रकार की एक घातक त्रुटि उत्पन्न करेगा। नीचे अधिक जानकारी:

 try { //    url        $webService = new PrestaShopWebservice($shop_url, $secret_key, $debug); //   $products = $webService->get( array( 'resource' => 'products' ) ); } catch ( PrestaShopWebserviceException $ex ) { $trace = $ex->getTrace(); //    $errorCode = $trace[ 0 ][ 'args' ][ 0 ]; //   if ( $errorCode == 401 ) //    echo 'Bad auth key'; else echo 'Other error : <br />' . $ex->getMessage(); } 

फिल्टर, छँटाई, सीमा

उपरोक्त सभी बहुत अच्छी तरह से प्रलेखन में लिखा है । और यहाँ इसे दोहराने का कोई मतलब नहीं है। बस यह मत भूलो कि यह अवसर मौजूद है। फ़िल्टर के लिए मान युक्त टैग का नाम निर्दिष्ट करके XML कार्ड से किसी भी फ़ील्ड द्वारा फ़िल्टर निर्दिष्ट किया जा सकता है।

नुकसान

फ़ील्ड प्रकार की आवश्यकताओं के अनुपालन के लिए मूल्य की सावधानीपूर्वक जांच करें, एक तुच्छ क्षेत्र में एक विसंगति कार्रवाई की एक श्रृंखला को पूरा करने में असमर्थता को जन्म देगी। अनुपालन की जाँच के लिए सभी क्षेत्र प्रकार और नियमित अभिव्यक्ति यहाँ स्थित हैं doc.prestashop.com ।

पुनश्च: अगर किसी के पास कोई प्रश्न है, तो मुझे उत्तर देने और सामग्री को पूरक करने में खुशी होगी।