🤚 🖨️ 🍫 JSON API My Warehouse、自己学習 💪🏾 🐾 🤸🏽

更新開始2019-11-18

この記事はまだ誰かのための情報源であることに気付きました。

コードをより簡単にするためにリファクタリングを行いました。途中で、いくつかの迷惑なバグを修正しました。

最終更新日2019-11-18

テストタスクの完了など、セルフトレーニングの方法があります。その利点は、タスクのボリュームが有限であり、時間が制限されることです。これは、無限にゴムを引っ張ったり、建築の喜びのひねりやカールを無我夢中で描くことを許可しません。

このようなスキルトレーニングの素晴らしいボーナスは、新しいテクノロジーとビジネスプロセスに精通することです。これは、とりわけ、実際のタスクで需要があります。

今回は、My Warehouseサービスで顧客注文を作成するページを作成する必要がありました。私にとっては、まるで月に飛んでいるようなものです。Web開発では初心者よりもやや少なく、フロントエンドは伝聞だけで知っていますが、ここではページ全体を開発する必要があります。

どんな批判やアドバイスも大歓迎です。

コメントには多くの宣誓がありますが、私の決定は非常に恐ろしいため、彼のために適切なリファクタリングを行いました。

michael_vostrikov

何もすることなく、私はこのタスクのリファクタリングを少し行いました（ただし、変更できるものは他にもたくさんあります）。後で検索でこの記事を見つけた人たちほどではありません。

コミット、マークアップ、フォーム送信。

行こう！

もちろん、最初のことはグーグルです。ドキュメント、チュートリアル、例へのリンクのみがグーグルです-ゼロ。

それでもグーグル：「JSON APIは、無料を除くすべての料金で加入者が利用できます」おっと！もちろん、誰も私に有料のものをくれなかったし、カミーユを買わなかったが、もし彼らが私にそのような割り当てを与えたなら、おそらく何かが無料のもので機能していて、働き続けたと思った。

そしてもちろん、「moysklad-client-npm-MySkladサービスAPIで快適に作業できるJavaScriptクライアント」はグーグルで検索されましたが、私はJSと「あなた」だけに専念しています。そのため、JSで何ができるかさえ理解できませんでした。

最初に

最初に行うことは、ドキュメントに精通することです。会った。

2つ目は計画を立てることです。コンパイル済み。

計画、始まり。

最初のアクションは承認です。

2番目のアクションは、命名法のリストを表示することです。

ステップ3-バイヤー注文を追加します。

4番目のアクションは、購入者の注文にアイテムを追加することです。

目標は達成され、計画は終了しました。

APIとの通信にcUrlが使用されているコードを見ました。 cUrlとは何か、APIとの通信方法はわかりませんが、コピーできるコードがあれば、その適合性を確認するのは難しくありません。私はそれをコピーし、貼り付け、ファイルで処理しました-判明しました。

コピーと貼り付けによるファイルの友情についての詳細は説明しません。ここに作業コードを示します。

function setupCurl($apiSettings) { $curl = curl_init(); curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, false); $userName = $apiSettings[MOYSKLAD_USERNAME]; $userPassword = $apiSettings[MOYSKLAD_PASSWORD]; curl_setopt($curl, CURLOPT_USERPWD, "$userName:$userPassword"); curl_setopt($curl, CURLOPT_USERAGENT, $apiSettings[MOYSKLAD_USER_AGENT]); return $curl; }

カールオプション：

RETURNTRANSFER-要求を送信するだけでなく、応答も記録します。
USERPWD-認証の詳細。

他のオプションは、なぜそれらが必要なのかわかりません、愚かなコピー＆ペースト。

最初の送信後にリセットされなかったという事実ではありませんが、承認ヘッダーを各リクエストで送信する必要があるという事実ではありません...

APIサーバーとのメッセージングのためのcurlオブジェクトの初期化でした。

使用法：

 function curlExec($curlObject) { $response = curl_exec($curlObject); $curlErrorNumber = curl_errno($curlObject); if ($curlErrorNumber) { throw new Exception(curl_error($curlObject)); } return $response; }

純粋なコピーアンドペースト、理由を聞かないでください。

アイテムのリストを表示

バイヤーの注文には、1つのアイテムだけでは不十分であることが判明しました。サプライヤーとバイヤーの取引相手の法人を示す必要があります。 My Warehouseアカウントの所有者は、複数の法人、カウンターパーティを持つことができます-100500であることは明らかですが、特定の購入者の注文は、特定の法人に対する特定のカウンターパーティの注文です。

したがって、命名法を待ち、「契約」の当事者である取引を扱います。

法人

 $curl = setCurl( $curl, $apiSettings[MOYSKLAD_API_URL] . $apiSettings[MOYSKLAD_GET_JURIDICAL_PERSON], $apiSettings[MOYSKLAD_GET_JURIDICAL_PERSON_METHOD]); $persons = getJuridicalPerson($curl); function setCurl(&$curlObject, $uri, $method) { curl_setopt($curlObject, CURLOPT_URL, $uri); curl_setopt($curlObject, CURLOPT_HTTPGET, true); switch ($method) { case MOYSKLAD_METHOD_GET: break; case MOYSKLAD_METHOD_POST: curl_setopt($curlObject, CURLOPT_POST, true); break; case MOYSKLAD_METHOD_PUT: curl_setopt($curlObject, CURLOPT_PUT, true); break; } return $curlObject; } function getJuridicalPerson($curlObject) { $response = curlExec($curlObject); $data = json_decode($response, true); $result = $data['rows']; return $result; }

定数の恐ろしい名前をおaびしますが、それらと混同しないように、私はそれらでよりリラックスしています。はい、ケース（スイッチ）にはデフォルトのブランチがあることは知っていますが、デフォルト値をコードに具体化して、ケースの不幸な運命に頼らない方が快適です。

各APIコマンドには、独自のアドレスと独自のメソッドsetCurlがあり、アドレスとメソッドを設定します。

法人のリストを取得するには、適切なアドレスとメソッドを設定します（アドレスとメソッドは設定で設定され、設定は関数getSettings（）{$ apiConfig = include（ 'moysklad_curl_details.php'）; return $ apiConfig;}によってロードされます）。

その後、getJuridicalPersonメソッドでcurlを実行し、JSONで応答を取得し、応答から「行」配列のみを取得します。受信、保存、延期。

カウンターパーティでは、同じアルゴリズムを使用します：setCurl => getCounterparty、同じアルゴリズムによる命名法：setCurl => getNomenclature。

仕事の後の2晩のテストではなく、失業者の2日間のテストであれば、それを自動化することは可能ですが、それは「仕事するだけ」のスタイルのテストだったので、気分を害することはありませんでした。

私にとって、テストの目標は、JSON APIをすすり、味わうこと、美しさを引き出すことでした-目標はありませんでした。

受け取ったデータ-それはまったく質問ではなく、愚かなことです-それはトリッキーなビジネスではありません。ページに持って行ってからページからそれを拾うのがより面白かったのです。

フロントエンド

私はそれを正しく行う方法がわかりません、私はこれをしました：

 echo '<form action="#" onsubmit="return false;" id="orderForm" ><p>  :<br />'; foreach ($persons as $key => $person) { $personId = $person['id']; echo '<label for="' . $personId . '">' . $person['name'] . '</label><input type="radio" data-organization-type="1" id="' . $personId . '" name="organization"><br />'; } echo ' :<br />'; foreach ($counterparty as $key => $person) { $personId = $person['id']; echo '<label for="' . $personId . '">' . $person['name'] . '</label><input type="radio" data-counterparty-type="1" id="' . $personId . '" name="counterparty"><br />'; } echo ' :<br />'; foreach ($nomenclature as $key => $position) { $positionId = $position['id']; echo '<label for="' . $positionId . '">' . $position['name'] . ',    => </label><input type="text" id="' . $positionId . '" data-position-type="1"><br />'; } echo ' <input type="submit" name="  " onclick="sendOrder();"><br /></p></form>'

一般的なアルゴリズム：

セクションの名前を書きます
ポジションの名前を書いて、
入力タグを記述し、id属性にAPIから取得した識別子を記述し、
属性を取得するには値を割り当てる必要があるため、対応する属性data-organization-type / data-counterparty-type / data-position-typeを記述します

（一般的に、もちろん、値なしで属性を使用できますが、その方法はわかりませんでした）。

「顧客注文の作成」ボタンをクリックすると、フォームは送信されません-「return false;」ですが、関数は「sendOrder（）;」と呼ばれます。

注文を送信

 echo ' <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js" type="text/javascript"></script> <script type="text/javascript"> function sendOrder(){ var $text_field = $('#orderForm :input:text'); var position = {}; $text_field.each(function() { var this_val = $(this).val(); var may_assign = this_val>0 || this_val !=""; var is_it_position = $(this).data('position-type'); if ( may_assign && is_it_position > 0){ position[this.id] = this_val; } }); var $radio_field = $('#orderForm :input:radio:checked'); var counterparty = {}; var organization = {}; $radio_field.each(function() { var this_val = $(this).val(); var is_it_counterparty = $(this).data('counterparty-type'); var is_it_organization = $(this).data('organization-type'); var may_assign = this_val>0 || this_val !=""; if ( may_assign && is_it_counterparty > 0){ counterparty[this.id] = this_val; } if ( may_assign && is_it_organization > 0){ organization[this.id] = this_val; } });

C JSは私には透明以上のようです。

$（ '＃orderForm：input：text'）; -orderForm識別子を持つタグ内のタイプテキストを持つすべての入力タグを選択しました
$ text_field.each-各要素に対して匿名関数を実行します
var this_val = $（this）.val（）; -保存された値
var may_assign = this_val> 0 || this_val！= ""; -値が空ではないことを計算
var is_it_position = $（this）.data（ 'position-type'）; -data-position-type属性が設定されていると計算された
if（may_assign && is_it_position> 0）{position [this.id] = this_val; }-値が空ではなく、この入力が位置に対応する場合、対応する要素を位置の配列に追加します。インデックスとしての識別子は一意性を保証します。

法人と対抗エージェントで同じアクロバットを行いますが、分析では「チェック済み」状態の「ラジオ」タイプのすべての入力を選択する点が異なります。

$（ '＃orderForm：input：radio：checked'）、さらに、input要素の値は必要ありません。購入者が選択したリスト全体から誰（1）を知る必要があるだけです。

処理に送信するデータの準備ができたので、リクエストを作成する必要があります。

  var postData = JSON.stringify({position : position, counterparty : counterparty , organization : organization}); console.log(postData); $.ajax({ type: "POST", url: "moyskald_add_order.php", data: postData, contentType: "application/json; charset=utf-8", dataType: "text", timeout: 10000, error: function(){ alert("  "); }, success: function(data){alert(data);}, failure: function(errMsg) { alert(errMsg); } });

このコピーペーストに追加するものはありません。送信方法は「POST」、処理は「moyskald_add_order.php」、データは「application / json;」の形式で行われます。 charset = utf-8 "、形式は-" text "です。

データはまったく必要ありませんが、もちろん、「注文が承認されました」または「注文の追加に失敗しました」とユーザーに伝えるのが良い口調です。

次の到着点である「処理」に進みます。

処理中

処理で不発が発生しました。私はEnameikレーマーであり、XAMPP（Win10の下）を開発に使用しています。そして、そのような何かが設定されています。通常の人としてPHPスクリプトへのGETリクエストを受け取り、POSTリクエストは1か所でしか取得できません。

ただし、GETはキャッシュされており、サーバーの応答が前回とまったく同じになるという事実はありません。特に開発中の場合、サーバーロジックは5分ごとに変更されます。

そのため、file_get_contents（「php：// input」）の形式でブラックマジックを使用する必要がありました。何をしても、var_export（$ POST）が安定して「array（）」を返したからです。ところで、正しい方向への一連のキックに感謝します。

そして、すべてが簡単です：

 $data = json_decode($rawData, true); $rawPosition = $data['position']; $rawCounterparty = $data['counterparty']; $rawOrganization = $data['organization'];

入力を解析しました。

法人と取引相手が引き出されました：

 const FIRST_INDEX = 0; $counterpartyId = $counterpartyIdCollection[FIRST_INDEX]; $organizationId = $organizationIdCollection[FIRST_INDEX];

形成されたリクエストフィールド：

 $textAddCustomerOrder = ' { "name": "' . time() . '", "organization": { "meta": { "href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/' . $organizationId . '", "type": "organization", "mediaType": "application/json" } }, "agent": { "meta": { "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/' . $counterpartyId . '", "type": "counterparty", "mediaType": "application/json" } } } '; $apiSettings = getSettings(); $curl = setupCurl($apiSettings); $curl = setCurl( $curl, $apiSettings[MOYSKLAD_API_URL] . $apiSettings[MOYSKLAD_ADD_CUSTOMER_ORDER], $apiSettings[MOYSKLAD_ADD_CUSTOMER_ORDER_METHOD]); curl_setopt($curl, CURLOPT_POSTFIELDS, $textAddCustomerOrder); curl_setopt($curl, CURLOPT_HTTPHEADER, array( 'Content-Type: application/json', 'Content-Length: ' . strlen($textAddCustomerOrder)) );

それから、json_encodeなしでjsonがフリーズし、愚かなことに正しい場所に識別子を貼り付けたことがわかりました。必ずPOSTFIELDS-$ textAddCustomerOrder、HTTPHEADER-'Content-Length：'を実行してください。 strlen（$ textAddCustomerOrder）。

APIサーバーに処理のリクエストを送信します：$ customerOrderId = setCustomerOrder（$ curl）、レスポンスで 'id'を取得します。

注文が追加されました。

バイヤーの注文にアイテムを追加する

プランのこのアイテムを使用すると、json_encodeを使用してリクエストテキストと、位置にある商品の数量のfloatvalをフォーマットする必要があること以外に問題はありません。 floatvalを使用しない場合、APIサーバーは数量フィールド（およびそれぞれ予約フィールド）のフォーマットエラーを生成します。

 $isPositionArray = is_array($rawPosition); $orderPositions= array(); if ($isPositionArray) { foreach ($rawPosition as $id => $quantity) { $positionQuantity=floatval($quantity); $orderPositions[] = [ "quantity" =>$positionQuantity, "price"=>0, "discount"=>0, "vat"=>0, "assortment" =>[ "meta"=>[ "href"=>"https://online.moysklad.ru/api/remap/1.1/entity/product/$id", "type"=>"product", "mediaType"=>"application/json" ] ], "reserve"=>$positionQuantity, ]; } }

注：foreach（$ rawPosition as $ id => $ quantity）、位置の識別子は配列のキーに書き込まれ、注文の数量は配列の要素の値に含まれます。

私の風水では、各配列を個別に作成し、すべての「基本」配列を一般的なヒープに追加する必要がありますが、...これは過度の狂信的だと思われます。

顧客の注文に予備金を設定する必要があるかどうかはわかりませんが、これはAPIを使用する仕組みよりもビジネス上の要件であるように思われます。

価格、アイテムをリストするために必要なタスク、私にとっては、価格は含まれていないアイテムと対応するTTXのリストですが、考えてみると、価格はそのようなアプリケーションの最初のTTXですが、注文フォームには価格がありません、したがって-合格しました。

リクエストAPIを送信すると、すべてが非常に明確になりました：

 $jsonResponse = 'empty'; $isContainPosition = count($orderPositions)>0; if($isContainPosition ){ $jsonOrderPositions= json_encode($orderPositions); $curl = setupCurl($apiSettings); $curl = setCurl( $curl, $apiSettings[MOYSKLAD_API_URL] . $apiSettings[MOYSKLAD_ADD_ORDER_POSITION_PREFIX] . $customerOrderId . $apiSettings[MOYSKLAD_ADD_ORDER_POSITION_SUFFIX], $apiSettings[MOYSKLAD_ADD_ORDER_POSITION_METHOD]); curl_setopt($curl, CURLOPT_POSTFIELDS, $jsonOrderPositions); curl_setopt($curl, CURLOPT_HTTPHEADER, array( 'Content-Type: application/json', 'Content-Length: ' . strlen($jsonOrderPositions)) ); $jsonResponse = setCustomerOrderPosition($curl); }

要求コマンドのアドレスは、やや奇妙な方法で「計算」されます。

 $apiSettings[MOYSKLAD_API_URL] . $apiSettings[MOYSKLAD_ADD_ORDER_POSITION_PREFIX] . $customerOrderId . $apiSettings[MOYSKLAD_ADD_ORDER_POSITION_SUFFIX]

ドキュメントによると、「/エンティティ/ customerorder / {id} /ポジション」です。

ネイティブPHP文字列のように、それを取り、それを正しく記述します-{id}を置き換えますが、APIコマンドの記述に関するハードコードを許可することはできません。もちろん、テストの記述中にコマンドは変更されませんが、Feng Shuiはそのようなグローバルなものを定数に取り込む必要がありますアーメン。あらゆる種類のオープンソースフレームワークのソースを見ると、そこにハードコードが非常に近いことがわかりますが、ハードコードはそれを実行し、実行しますが、実行しません。

エピローグ

それだけです。 APIは、無料料金で、最後のターンでリクエストを処理するため、10秒のタイムアウトでは不十分な場合があります。残りは安定して動作します。確認しました。

もちろん、私たちの目標はこれではありませんでした。割り当ての結果、JSON Web APIを操作する方法を学び、フォームに情報を出力し、サーバースクリプトに処理するためのユーザー入力を渡すことでフロントエンドをかき立てる方法を学びました。

やったー

PostScriptum

記事を書く前に、「php json api my warehouse」というトピックについてもう少し詳しく調べてみましたが、多くの実装が見つかりましたが、JSONではなくXMLです。発見されたダースのうち、いくつかは実際に機能していることに似ていますが、2017年3月31日以降、XML APIが無効になると脅されているため、これは関係ありません。

または、「JSON APIは、無料を除くすべての料金で加入者が利用できます」と同じになります。

建設的な批判と最高の実践へのリンクようこそ！私は集合的な農民であることを恥じていませんが、それがより良いのなら、それは良くないでしょうか？

JSON API My Warehouse、自己学習