はじめに
スマレジ・デベロッパーズについて学んできたことを、『スマレジ・アプリマーケットのアプリ開発のはじめ方』というタイトルで投稿します。全 5 回です。
「スマレジ・アプリマーケット」とは、スマレジ・デベロッパーズに登録すると、スマレジ API が利用できて、その API を使用して作成したアプリをスマレジユーザー向けにプラットフォームで販売できますよ、というものです。
それをもう少し詳しく見ていくのが今回の記事です。
スマレジ公式のチュートリアル、その他開発パートナーの方が書いた Qiita 記事などを参考にしながら、調べたり手を動かしてきた内容について、記事にしていきます。
本記事の目的
本記事は、以下を目的としています。
- スマレジ・デベロッパーズでの開発に興味をお持ちの方にどんなものか共有したい。
- スマレジ・デベロッパーズをご存じない開発者の方に興味を持っていただきたい。
- 自身のスマレジ・デベロッパーズに関する知識を習得、定着させたい。
投稿内容(全 5 回)
本連載は以下の順序で投稿していきます。
-
① スマレジ・デベロッパーズとは
- 「スマレジ・デベロッパーズ」をはじめ、「スマレジ・アプリマーケット」と「スマレジ・プラットフォームAPI」、「スマレジ・デベロッパーズ・コミュニティ」について、どのようなものか簡単に確認します。
-
② スマレジ・デベロッパーズのアカウント登録
- スマレジ・アプリマーケットのアプリ開発者になるために、スマレジ・デベロッパーズのアカウントを登録して、開発環境を準備します。
-
③ アプリの新規登録
- スマレジ・デベロッパーズでのアプリの新規登録の方法を確認します。
-
④ アプリアクセストークン取得 API の使い方
- スマレジ・プラットフォームAPIを実際に使ってみます。APIをテストできるアプリである Postman のアカウント登録・使用し、 スマレジ・プラットフォームAPI の アプリアクセストークン取得 をします。
-
⑤ 商品一覧取得 API の使い方
- Postman で実際に スマレジ・プラットフォームAPI の一つである 商品一覧取得 のAPI を使用します。
今回は導入として、① スマレジ・デベロッパーズとは なにかについて、整理していきます。
目次
1. スマレジ・デベロッパーズとは
(画像引用元:https://user-requests.smaregi.jp/developer)
スマレジ・デベロッパーズは、スマレジ・アプリマーケットで公開(販売)するアプリの開発者のためのプラットフォームです。デベロッパーは「開発者」なので、わかりやすい名前ですね。上記の画像では、右上の青いマルの「スマレジアプリ開発環境」が、スマレジ・デベロッパーズに該当します。
スマレジ・デベロッパーズの開発パートナーとしてアプリを開発したら、スマレジ・アプリマーケットで公開して、スマレジを利用している小売店や飲食店に向けて販売することができます。
iPhoneなどのApple製品に置き換えて考えると、 iOSアプリ を開発したら、 App Store で公開して、 Appleユーザー に向けて販売する、という感じですね。
なお、スマレジ・デベロッパーズのアカウント登録して利用できるスマレジ・アプリマーケットのアプリを開発するための環境(サンドボックス環境、スマレジ・プラットフォームAPI利用など)は、だれでも無料で手に入れることができます。
ただ、環境を手に入れたその先は、Webアプリ(もしくはネイティブアプリ)の開発をするための、アイデアや開発者としての相応の技術力が必要です!…
2. スマレジとは
ところでスマレジはどのようなサービスかご存じでしょうか。
スマレジは以下の3つのプロダクトを提供しています。
- スマレジ
- スマレジ ・ウェイター
- スマレジ ・タイムカード
スマレジ
スマレジは、高機能クラウドPOSレジで、小売やアパレル、飲食店など多くのニーズに応える機能を有し、シンプル操作、時間や場所を選ばないリアルタイムな売上分析を実現します。
スマレジ・ウェイター
スマレジ・ウェイターは、iPhoneなどを高機能ハンディとして利用できるオーダーエントリーシステムです。飲食店の店員(ウェイター)さんがiPhoneで注文を受けて、その注文内容をスマレジと連携して一元管理できます。
スマレジ・タイムカード
スマレジ・タイムカードは、高機能・多機能な勤怠管理サービスで、従業員をクラウド勤怠システムで一元管理できます。
これら3つのスマレジのプロダクトに関連するアプリを、スマレジ・アプリマーケットで公開して、販売することができます。
3. スマレジ・アプリマーケットとは
スマレジ・アプリマーケットは、アプリを公開するプラットフォームです。
スマレジ・アプリマーケットで公開するアプリとは、スマレジの基本機能に加えて、業種・業態や利用状況に合わせた機能を追加するアプリです。
スマレジ を iPhoneなどのApple製品 に置き換えて考えると、以下のとおりです。
- スマレジ・アプリマーケット → App Store
- スマレジ・アプリマーケットの アプリ → App Store の iOSアプリ
App Store から iOSアプリをインストールすると、iPhoneの基本機能だけでは今までできなかったことが、アプリを利用してできるようになる、つまりは機能が追加されている、というイメージです。
スマレジ・アプリマーケットのアプリには、例えば以下のようなアプリがあります。
他にもスマレジ・アプリマーケットで実際にどのようなアプリが公開されているかを見ることで、アプリのイメージの参考になるかと思います。
これらのスマレジ・アプリマーケットのアプリは、スマレジ・プラットフォーム API を利用することで、スマレジと連携して、機能を提供しています。
4. スマレジ・プラットフォーム API とは
スマレジ・プラットフォーム API については、仕様書があり、その中で下記のような説明があります。
スマレジ・プラットフォームAPIを利用する事で、仕様の範囲内で外部システムから、スマレジをはじめ、スマレジ ・ウェイター、スマレジ ・タイムカード、各プロダクトのデータにアクセスすることができます。
ちなみに API は、 Application Programming Interface の略で、システムが提供する機能を外部の別のシステムから呼び出して利用するものです。
つまり、アプリからスマレジに対して「データちょうだい!」とリクエストして、スマレジからアプリに対して「データどうぞ!」とレスポンスをもらうために利用するのがスマレジ・プラットフォーム API です。
スマレジ・プラットフォーム API の仕様書
スマレジ・プラットフォーム API には、以下の4つの仕様書があります。
-
スマレジ・プラットフォームAPI 共通仕様書
- 基本情報、APIエンドポイント、アクセストークンなどについての仕様が書いてあります。
-
スマレジ・プラットフォーム API POS 仕様書 (ver.1.0.0)
- スマレジ(POS)の各 API についての、リクエスト、レスポンスなどについての仕様が書いてあります。
- API の種類を数えようとしましたが、200を超えたところで見失いました…
-
スマレジ・プラットフォーム API Waiter 仕様書 (ver.1.0.0)
- スマレジ・ウェイターの各 API についての、リクエスト、レスポンスなどについての仕様が書いてあります。
-
スマレジ・プラットフォーム API Timecard 仕様書 (ver.1.1.0)
- スマレジ・タイムカードの各 API についての、リクエスト、レスポンスなどについての仕様が書いてあります。
次回以降の記事でスマレジ・プラットフォーム API を使ってみる際には、上2つの 共通仕様書 と POS 仕様書 の内容に基づいて HTTP リクエスト の設定をしていきます。
5. スマレジ・デベロッパーズ・コミュニティとは
スマレジ・デベロッパーズ・コミュニティは、スマレジ・プラットフォームAPIについての技術的なコミュニティサイトです。
API の使用方法や、認証方法、アプリ作成のための知見を共有するためのコミュニティサイトであり、スマレジ・アプリマーケットのアプリ開発に関する技術的な質問をして、スマレジの中の人に回答をもらうことのできる場です。
百聞は一見にしかずということで、サイトをご覧いただければ、どのようなものかすぐにご理解いただけるかと思います。なお、ログインしていなくても閲覧可能です。
おわりに
今回は、 ① スマレジ・デベロッパーズとは というタイトルで、「スマレジ・デベロッパーズ」をはじめ、「スマレジ・アプリマーケット」と「スマレジ・プラットフォームAPI」、「スマレジ・デベロッパーズ・コミュニティ」について、どのようなものか簡単に確認しました。
次回は、 ② スマレジ・デベロッパーズのアカウント登録 というタイトルで実際の手順を見ていきます。
スマレジ・アプリマーケットのアプリ開発者になるために、スマレジ・デベロッパーズのアカウントを登録して、開発環境を準備します。
ありがとうございました。