{"id":20326,"date":"2024-03-14T10:50:20","date_gmt":"2024-03-14T01:50:20","guid":{"rendered":"https:\/\/standard.raku2bb.com\/faq\/?p=20326"},"modified":"2024-05-10T18:58:27","modified_gmt":"2024-05-10T09:58:27","slug":"02-0695","status":"publish","type":"post","link":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/api\/02-0695\/","title":{"rendered":"\u57fa\u672c\u8a2d\u5b9a\uff1e\u5916\u90e8\u30a2\u30d7\u30ea\u9023\u643a"},"content":{"rendered":"

設定方法<\/h2>\n\n\n\n

API連携の設定です。<\/p>\n\n\n\n

アプリケーション登録<\/h3>\n\n\n\n

基本設定＞外部アプリ連携<\/span><\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n
項目<\/th>\n内容<\/th>\n<\/tr>\n<\/thead>\n
アプリケーション名<\/td>\n任意でアプリケーション名を設定してください。<\/td>\n<\/tr>\n
リダイレクトURL<\/td>\nリダイレクトURLを設定してください。
リダイレクトURLには認証情報を受け取るURLを指定してください。<\/td>\n<\/tr>\n
IP制限<\/td>\n許可するIPアドレスを設定してください。
未設定の場合は無制限で許可します。<\/td>\n<\/tr>\n
クライアントID<\/td>\n新規登録時は空欄で登録してください。
登録すると発行されます。<\/td>\n<\/tr>\n
シークレットID<\/td>\n新規登録時は空欄で登録してください。
登録すると発行されます。<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

認証ページ表示<\/h3>\n\n\n\n

https:\/\/{ドメイン名}\/api\/oauth\/authorize.php に、必要なパラメータをつけてGETリクエストを行ってください。
アカウントの認証を行うHTMLページが表示されます。<\/p>\n\n\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n
パラメータ名<\/th>\n有効な値<\/th>\n<\/tr>\n<\/thead>\n
client_id<\/td>\nアプリケーション詳細画面で確認できるクライアントID<\/td>\n<\/tr>\n
response_type<\/td>\n“code”を指定<\/td>\n<\/tr>\n
redirect_uri<\/td>\nアプリケーション登録時に入力したリダイレクトURLと同一のものを指定<\/td>\n<\/tr>\n
state<\/td>\n任意の文字列<\/td>\n<\/tr>\n
scope<\/td>\n予約パラメータです。現在は指定できません。<\/span>
アプリケーションが利用したい機能をスペース区切りで指定します。<\/span>
“read_products” = 商品データを参照
“write_products” = 在庫データを更新
“read_sales” = 受注・顧客データを参照
“write_sales” = 受注データを更新<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n
（例）\nhttps:\/\/{スマレジEC・B2Bドメイン名}\/api\/oauth\/authorize.php?client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&state=a397aabc602f7e296db23b0717edd1fda06c345f\n<\/pre>\n\n\n\n
    \n
  • URLにアクセスすると、認可ページが表示されます。<\/li>\n\n\n\n
  • スマレジEC・B2Bカウントを持つ利用者は、このページでアプリケーションがショップのデータにアクセスることを許可します。<\/li>\n\n\n\n
  • はじめて許可ページへ訪れる利用者は、スマレジEC・B2Bの管理者ログインID・パスワードの入力を求められます。<\/li>\n<\/ul>\n\n\n\n
    認可コードを取得<\/h3>\n\n\n\n
    リダイレクトURLに指定したURLで許可コードが取得できます。<\/p>\n\n\n\n
    例） 
    https:\/\/{御社ツールドメイン名}\/getAuth.php?code=xxxxxxxxx&state=zzzzzzzzz <\/p>\n\n\n\n
    codeの値が認可コードになります。<\/p>\n\n\n\n
    アクセストークン取得<\/h3>\n\n\n\n
    認可コードを利用してアクセストークンを取得します。
    https:\/\/{スマレジEC・B2Bドメイン名}\/api\/oauth\/token.php に対してPOSTリクエストを行います。<\/p>\n\n\n\n
    リクエストパラメータ<\/strong><\/p>\n\n\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n\n
     
    パラメータ名<\/th>\n有効な値<\/th>\n<\/tr>\n<\/thead>\n
    client_id<\/td>\nアプリケーション詳細画面で確認できるクライアントID<\/td>\n<\/tr>\n
    client_secret<\/td>\nアプリケーション詳細画面に表示されているシークレット文字列<\/td>\n<\/tr>\n
    code<\/td>\n取得した認可コード文字列<\/td>\n<\/tr>\n
    grant_type<\/td>\n“client_credentials”を指定<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n
    レスポンスデータ<\/strong><\/p>\n\n\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n
     
    パラメータ名<\/th>\n有効な値<\/th>\n<\/tr>\n<\/thead>\n
    access_token<\/td>\nアクセストークン<\/td>\n<\/tr>\n
    expires_in<\/td>\n有効期限<\/td>\n<\/tr>\n
    refresh_token<\/td>\nリフレッシュトークン<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n
    リクエストが成功すると、以下のようなレスポンスがJSONで返ります。
    <\/p>\n\n\n\n
    {"access_token":"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX","token_type":"beare r","expires_in":null,"refresh_token":null,"scope":""}
    <\/pre>\n\n\n\n
    access_tokenプロパティに格納されている値が、アクセストークンです。
    アクセストークンを取得すれば、スマレジEC・B2BAPIにアクセスする準備は完了です。<\/p>\n\n\n\n
      \n
    • 認可コードをアクセストークンに交換できるのは１度だけです。<\/li>\n\n\n\n
    • アプリケーション側で保存できるようにしてください。<\/li>\n\n\n\n
    • アクセストークンは、許可済みアプリケーション一覧画面から失効させることができます。<\/li>\n<\/ul>\n\n\n\n
      API情報の呼び出し<\/h3>\n\n\n\n
        \n
      • アクセストークンつきでHTTPリクエストを行うことで、スマレジEC・B2BAPIにアクセスすることができます。<\/li>\n\n\n\n
      • リクエスト、レスポンス、どちらもJSONでやりとりを行います。<\/li>\n\n\n\n
      • 各APIは、URLとHTTPメソッドで操作を表します。　<\/li>\n<\/ul>\n\n\n\n
        　　・GET参照
        　　・POST新規登録
        　　・PUT更新
        　　・DELETE削除<\/p>\n\n\n\n
          \n
        • POST,PUTの際には、ヘッダに Content-Type: application\/json をつけ、リクエストボディにJSONを送信します。<\/li>\n\n\n\n
        • リクエストボディのJSONに日本語が含まれる場合は文字コードはUTF-8、\\uNNNN形式でエンコードされている必要があります。<\/li>\n\n\n\n
        • Authorizationヘッダに以下の形式でアクセストークンを付与し、各APIへのリクエストを行います。<\/li>\n<\/ul>\n\n\n\n
          Authorization: Bearer 0908dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX<\/pre>\n\n\n\n
          サンプルコード<\/h3>\n\n\n\n
          ※以下はサンプルです。URLやパラメータは便宜修正してください。<\/p>\n\n\n\n
          アプリケーションのWebサーバのサンプル<\/p>\n\n\n\n
          <?php\n\n define("OAUTH2_SITE", 'https:\/\/{スマレジEC・B2Bドメイン}');\n define("OAUTH2_CLIENT_ID",'XXXXX');      \/\/ クライアントIDを入力します。\n define("OAUTH2_CLIENT_SECRET", 'XXXXX'); \/\/ クライアントシークレットを入力します。\n define("OAUTH2_REDIRECT_URI", 'http:\/\/example.com\/index.php');\n\n $code = $_GET['code'];\n $state = sha1(uniqid(mt_rand(), true));  \/\/任意の文字列をセット。\n\/\/ 認可ページへリダイレクトする \nif (empty($code)) {\n     $params = array( \n        'client_id'     => OAUTH2_CLIENT_ID, \n        'redirect_uri'  => OAUTH2_REDIRECT_URI,\n         'response_type' => 'code',\n         'state'         => $state\n     );\n     $auth_url = OAUTH2_SITE . '\/api\/oauth\/authorize.php?' . http_build_query($params);\n     header('Location: ' . $auth_url);\n     exit;\n } \n\/\/ 認可後\n $params = array(\n     'client_id'     => OAUTH2_CLIENT_ID,\n     'client_secret' => OAUTH2_CLIENT_SECRET,\n     'code'          => $code,\n     'grant_type'    => 'client_credentials',\n     'redirect_uri'  => OAUTH2_REDIRECT_URI\n );\n $request_options = array(\n     'http' => array(\n         'method'  => 'POST',\n         'content' => http_build_query($params)\n     )\n );\n $context = stream_context_create($request_options);\n\n $token_url = OAUTH2_SITE . '\/api\/oauth\/token.php';\n $response_body = file_get_contents($token_url, false, $context);\n $response_json = json_decode($response_body);<\/pre>\n\n\n\n
          アクセストークンを用いたPUTリクエストのサンプル<\/p>\n\n\n\n
          <?php

           $arrParam = array();
           $arrParam['serial_order_id'] = '5'


           $api_url = 'https:\/\/{スマレジEC・B2Bドメイン}\/api\/v1\/orders.php?' . http_build_query($arrParam);
           $api = new HTTP_Request($api_url, $option);
           \/\/ POSTで送信
           $api->setMethod(HTTP_REQUEST_METHOD_GET);
           \/\/ Header設定
           $api->addHeader('Authorization', "Bearer {アクセストークン}");
           \/\/ HTTPリクエスト実行
           $response_api = $api->sendRequest();
           $status_code = $api->getResponseCode();
           $response_body_api = $api->getResponseBody();
           $response_body_api = json_decode($response_body_api);
           ?><\/pre>\n","protected":false},"excerpt":{"rendered":"
          設定方法 API連携の設定です。 アプリケーション登録 基本設定＞外部アプリ連携 項目 内容 アプリケーション名 任意でアプリケーション名を設定してください。 リダイレクトURL リダイレクトURLを設定してください。リ・・・<\/p>\n","protected":false},"author":17,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_links_to":"","_links_to_target":""},"categories":[14],"tags":[],"views":708,"_links":{"self":[{"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/posts\/20326"}],"collection":[{"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/users\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/comments?post=20326"}],"version-history":[{"count":12,"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/posts\/20326\/revisions"}],"predecessor-version":[{"id":43999,"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/posts\/20326\/revisions\/43999"}],"wp:attachment":[{"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/media?parent=20326"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/categories?post=20326"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ec.smaregi.jp\/b2b\/standard\/faq\/wp-json\/wp\/v2\/tags?post=20326"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}