WebAPI20230326.pdf

目次
● 本勉強会の趣旨
● Web APIとは？
● アクセストークンについて
● 身近な例
● スマレジAPI公開からスマレジ・アプリマーケットへ
● スマレジの成長
● API５つのメソッドの説明
● 具体的に説明（GET、POST、Webhook）
● Webhookとは？
● 簡単な問題を２つほど

勉強会の趣旨
APIの事を理解することで、商談や折衝に自信をもって臨めるようになる。

Web APIとは？
オーライリー・ジャパンの書籍によると、
Web APIとは「HTTPプロトコルを利用してネットワーク
越しに呼び出すAPI」です。
とありますが、
よく解らん...ので、言い換えます。
書籍：オーライリー・ジャパン
「Web API The Good Parts」

Web APIとは？
● Application Programming Interfaceの略称
● Web APIとは、Web上で利用することのできるアプリケーション・プログラミング・イ
ンターフェースのことです。
● APIを使うことで、外部のアプリケーションからデータを取得したり、データを送るこ
とができます。
店舗POSレジ Webアプリ
データを送る
データを取得する
アプリ

API
API
アプリケーション・プログラミング・インターフェース
A（エー）：Application（アプリケーション）※スマレジ、会計ソフト、
LINEなどのアプリ
P（ピー）：Programming（プログラミング）※プログラミング
I（アイ）：Interface（インターフェース）（接点）※窓口みたいなイメージ
店舗POSレジ
API
BASE
連携
アプリ
EC
モール
売上
通知
アプリ
Hub
アプリ
会計
ソフト
在庫連携
アプリ
BASE
LINE
Shopigy
API
API
API
API
Make
shop

アクセストークンについて

誰でもいつでもアクセスできるわけではない
● スマレジはAPIを公開していますが、誰でもいつでもアクセスできるわけではありません。
● アクセスするには開発者登録をして「クライアントID」と「クライアントシークレット」を取得後、
アク
セストークンを取得しなければなりません。
Developersサイトから
無料で開発者登録をする
ことができます。

アクセストークンとは？
● APIを利用するために、API公開事業者がユーザーを認証するために払い出した認証情報のこ
とです。
通常はユニークなランダムな英数字
（例）zf14dffq3fg46ghg7dip1ash74ioisud
スマレジでは、データの参照や更新を
API経由で行うには、アプリユーザーのアクセストークンを取得
する必要があります。

アプリとしてスマレジユーザーのデータにAPIアクセスするには、
必ずアクセストークンが必要です。
アプリ
あらかき商店
POSレジ
アクセストークンがないと
アクセスできない
×
ダメ！

アプリとしてスマレジユーザーのデータにAPIアクセスするには、
必ずアクセストークンが必要
アプリ
あらかき商店
POSレジ
アクセストークン
zf14dffq3fg46ghg7dip1ash74ioisud
アクセストークによって
アプリが認証され
APIにアクセスできるようになる
OK！

アクセストークンについてまとめ
アプリ
あらかき商店
POSレジ
● スマレジはAPIを公開しているが、いつでも誰でもアクセスできるわけではない。
● アクセスするには、開発者登録が必要。
● 開発者登録後「クライアントID」と「クライアントシークレット」を取得し、その情報で「アクセストー
クンを取得する」ことで、APIにアクセスできるようになる。
取得方法の詳細はnoteをご覧ください。
「アクセストークンがなければアクセスできないんだな」と理解していれば
OKです。

（例１）ニュースアプリで天気を表示させる。
Yahoo気象情報API
Yahoo気象情報API
にアクセスして
Yahoo
気象情報API
今日の大阪の天気情報を
取得する
全国各地の
天気情報を
もっている
大阪の
天気情報
ニュースアプリ

（例２）会計ソフトで指定の銀行口座残高を表示させる
外部連携サービス（三井住友銀行）
API
〇〇銀行のAPI
口座の残高
情報をもっ
ている
口座番号
12345
残高
指定した口座の
残高を取得する
会計ソフト

スマレジAPIの例
売上情報を自動でLINEにメッセージ配信してくれるアプリ
Webアプリ
スマレジAPI
API
売上高情報を
取得する
LINE
取得した売上高情報を
LINE メッセージする
売上を自
動でLINE
にメッセー
ジ送信す
るアプリ
〇月〇日
売上
100万円
メッセージを
受信する
API公開
スマレジPOS API
API公開
LINE Messaging API

これらは
APIがあるからこそ実現している。
逆に言うと
APIがないと、こんなことはできない。

APIって素敵だ。
APIを公開することで
外部サービスとの連携を容易にして
新たな価値が生まれる。

スマレジAPI公開から
スマレジ・アプリマーケット誕生の流れ
当初からスマレジはAPIをオープンに公開していたが、公開するだけでは、活用して新たな価値
を創造するユーザーを増やすのが限定的になってしまう
...
（活用促進の限界）
そこで！
外部の開発会社にスマレジのAPIを活用してスマレジと連携するサービスをアプリとして販売で
きるアプリマーケットが誕生し、スマレジ上で3者一体となるエコシステムを構築した。
当初はPOSレジという
事業ドメインで戦ってきた
店舗DXソリューション
事業ドメインで戦えるようになっ
た
アプリマーケットが
できたことで

スマレジの歴史を振り返ります。

スマレジの成長（新垣の見解）
当社は、2010年に「クラウドPOSレジ」から始まり、2012年に「Waiterをリリース」2014年
に「TIMECARD」をリリース、2020年7月に「スマレジ・アプリマーケット」をリリース、
2022年7月に「PAYGATE」の販売を開始した。
当初は「クラウドPOSレジというカテゴリー（事業ドメイン）」で戦ってきたが、今では「店舗
DXというカテゴリー」に事業ドメインを広げている。
企業や個店の経営課題が複雑化する中、ただ単純に「POSレジサービス」を提供するだ
けではなく、他のサービスやアプリを組み合わせることで、業務効率化や生産性アップ、
ID－POSの実現など、店舗DXを実現させるソリューション提案ができるようになってき
た。

Web APIの話しにもどします

Web APIには
５つのメソッドがあります。

メソッド名説明
GET リソースの取得
POST リソースの新規登録
PUT 既存リソースの更新（書き換え）
DELETE リソースの削除
PATCH リソースの一部変更（一部修正）
A B
どんな事ができるの？ API「5つメソッド」

どんな事ができるの？ API「5つメソッド」
メソッド名説明
GET 情報を取ってくる
POST 新しい情報を送る
PUT 今ある情報を更新する（書き換え）
DELETE 情報を削除する
PATCH 情報の一部を変更（一部修正）
A B

GET
● テイクアウトアプリに商品を登録するために、スマレジに登録されている商品情報を
取得する（GET）。
店舗POSレジ
テイクアウトの
注文受付アプリ
GETメソッドで
商品情報を取得する
商品A
100円
商品B
150円
商品C
200円
スマレジAPIを活用すれば、テイクアウト用アプリに商品登録する手間を省ける。
商品A
100円
商品B
150円
商品C
200円

POST
● テイクアウトアプリ経由で売り上げが上がるたびに、自動でスマレジに売り上げが
登録される（POST）。
店舗POSレジ
POSTメソッドで
売上情報を送る
商品A
100円
売れた
商品A
売上
100円
売上が上がる
自動で売上が登録される

PUT
そこまで使わないので、下記のように覚えておけばOKです。
データの置き換え、切り替えをするイメージ。
・飲食注文キャンセル
・テーブル利用のキャンセル
・テーブルチェックアウト

DELETE
● スマレジに登録されている商品情報を削除する（DELETE）
店舗POSレジ
DELETEメソッドで
商品情報を削除する
商品A
の情報
を削除
商品A
の情報
が削除
される

PATCH
● テイクアウトアプリの商品名を変更すると、スマレジに登録してある商品名も書き換
えられる（PATCH）
店舗POSレジ
PATCHメソッドで
商品名を書き換える
商品A
の商品
名を
商品Z
に変更
商品名
商品A
が
商品Ｚ
に
書き換
えられ
る

具体例「売上をLINEに自動で通知するアプリ」
その日の売上を自動でLINEに送信するアプリ
アプリl
スマレジAPI
GET
その日の売上情報を
取得する
LINE
LINE APIにPOSTする
〇月〇日
売上
100万円
メッセージを
受信する
API公開 API公開
アプリ

売上情報が自動でLINEに送られてきたらいいのになー
スマレジAPI
アプリ
GET
取得する
LINE
〇月〇日
売上
100万円
メッセージを
受信する
API公開 API公開
どのタイミングで
GETメソッドを発動
させるの？
アプリ

Webhookとは？
Webhookとは、アプリケー
ションでイベントの実行や更
新があった際、外部サービ
スにお知らせする仕組みで
す。

Webhookについて
スマレジでレジ締めというイベントが実施されたら、
Webhookが飛んでくる。そんな風にイメージしてくださ
い。
※スマレジのWebhookについてはコチラ
１．一日の営業が終わり、スマレジでレジ締め作業が行われる
↓
２．「レジ締め」をきっかけに
Webhookが飛ぶ
↓
３．宛先に届く

Webhookとは？
１．一日の営業が終わり、スマレジ
でレジ締め作業が行われる
↓
２．「レジ締め」をきっかけに
Webhookが飛ぶ
↓
３．宛先に届く

売上情報が自動でLINEに送られてきたらいいのになー
アプリ
スマレジAPI
②Webhookを合図に
GETメソッドを発動
取得する
LINE
③取得した売上高情報を
〇月〇日
売上
100万円
メッセージを
受信する
API公開 API公開
④
①レジ締めの
タイミングで
Webhookが飛ぶ
アプリ

BASE在庫連携
スマレジAPI
②商品Aの在庫を
1個減少させる
BASE
①BASEで
商品Aが
１個
売れた！
API公開
メソッド
問１の中にはどのメソッドが入るでしょうか？

BASE在庫連携
スマレジAPI
②商品Aの在庫を
1個減少させる
BASE
①BASEで
商品Aが
１個
売れた！
API公開
メソッド
POST
API仕様書を見る
在庫情報を更新します。
在庫数は、現在の値に対し、入力された値を加算（入力値が負の場合は減算）した値に更新します。
問１の中にはどのメソッドが入るでしょうか？

問２の中にはどのメソッドが入るでしょうか？
BASE在庫連携
スマレジAPI
②商品情報を
取得する
BASE
③取得した商品情報を
登録する
商品が
登録される
API公開
④
①新しく商品が
登録された
Webhookが飛ぶ
メソッド
メソッド

BASE在庫連携
スマレジAPI
②商品情報を
取得する
BASE
登録する
API公開
登録された
Webhookが飛ぶ
メソッド
メソッド
GET
POST
商品が
登録される
④

BASE在庫連携
スマレジAPI
②商品情報を
取得する
BASE
登録する
API公開
登録された
Webhookが飛ぶ
メソッド
メソッド
商品が
登録される
④

BASE在庫連携
スマレジAPI
②商品情報を
取得する
BASE
登録する
API公開
登録された
Webhookが飛ぶ
メソッド
メソッド
GET
POST
商品が
登録される
④
答え
BASEもAPIを公開しているから

以上、お疲れ様でした！

WebAPI20230326.pdf

More Related Content

Similar to WebAPI20230326.pdf

Recently uploaded

WebAPI20230326.pdf