【チュートリアル⑦】Developers APIのクライアントを作成する
本チュートリアルでは、Developers APIを利用するためのクライアントを作成した後、そのクライアント情報を利用してDevelopers APIを実行するまでを記載します。
DevelopersAPIをご利用いただくことで、例えば下記のような事が可能になります。
購入はしたがスマレジにログインをしておらず、メールアドレスを収集できないお客様向けにリマインドメールの通知を行う。
定期的にシステムアップデートのための通知メールを送付する。
具体的なDevelopers APIの仕様は、下記の仕様書をご確認ください。
Developers APIクライアントを作成する
設定 / Developers API で Developers APIページにアクセスします。
Developers APIページ下部にクライアントとあります。初期状態ではクライアントがない状態なので、クライアントを作成していきます。
クライアントを追加をクリックすることでモーダルが開きます。
任意のクライアント名を入力して、追加をクリックしましょう。
再度Developers APIページを確認するとクライアントが作成されているのが確認できます。
クライアントIDとクライアントシークレットを確認する
該当クライアントのカードをクリックするとモーダルが開いてクライアント情報が表示されます。
先ほど入力した任意のクライアント名に対して、クライアントIDとクライアントシークレットが発行されているのが確認できます。
右側のコピーボタンをクリックすることで、クライアントIDとクライアントシークレットをそれぞれコピーすることができます。
クライアント情報を利用してDevelopers APIを実行する
先ほど作成したクライアントのクライアントIDとクライアントシークレットを利用してDevelopers APIを実行していきます。
Developers APIのエンドポイントURLはスマレジ・デベロッパーズAPI仕様にある通り下記になります。
https://api.developers.smaregi.dev/v1
Postmanを利用して取得する
利用者一覧取得APIは
https://developers.smaregi.dev/apidoc/developers_api/#tag/利用者一覧/operation/getAppUsers
の通り、
https://api.developers.smaregi.dev/v1/apps/{アプリキー}/users
とあります。
Tips: アプリキーとは？
アプリキーとは全てのパブリックアプリに一意に割り振られているキーになります。
パブリックアプリを登録した時点で、アプリキーが割り当てられます。
アプリキーはアプリ / パブリックアプリ / 該当アプリ詳細ページ / 基本情報に記載されていますので、こちらから取得してください。
ここで確認したアプリキーを{アプリキー}の部分と置換し
https://api.developers.smaregi.dev/v1/apps/xxxxx/users
宛にGET通信を行います。
AuthorizationはBasicAuthを選択し、UsernameにクライアントID、Passwordにクライアントシークレットを設定してください。
必要に応じて検索条件などを設定していただいても構いません。ここでは特にクエリパラメータを設定せずにそのままAPIを実行します。
次のチュートリアルはこちら
ユーザ様のDX事例や最新ニュースなどをお届けして参ります。
友だち登録よろしくおねがいします！