こんにちは！
Yuki (@yukibnb) です。
今回から複数の記事に渡ってBeds24のAPI (エーピーアイ) を活用する方法を紹介します。
Beds24は単体でもすごく便利なサービスですがAPIを活用するとさらに便利になります。
「APIって何？」「API連携は興味あるけどなんだか難しそう」という方にもわかりやすいように細かくご紹介します。
では早速見ていきましょう！
APIについて
APIってそもそも何？
APIはApplication Programming Interface (アプリケーションプログラミングインターフェース) の略称です。
インターフェースとは何かと何かを繋ぐものです。
例えば私たちが普段使っているパソコンのキーボードやマウスは、「人間」と「コンピューター」をつなぐインターフェースです。
ではAPIは何と何を繋ぐかというと、異なるアプリケーション同士を繋ぐものです。「API連携」と言います。
APIを活用することでBeds24と別のアプリケーションを繋ぐことができるようになり、2者間でデータのやり取りをスムーズに行うことができます。
※APIについてもっと詳しく知りたい方は以下記事がわかりやすくておすすめです。
www.sejuku.net
どんな使い方があるの？
Beds24のAPIを活用すれば、例えばBeds24の予約情報一覧をGoogleスプレッドシートに毎日自動的に反映させることができます。
手動で行う場合と比較してみましょう。
【手動で行う場合】
- Beds24にログインする
- [Booking list]ページを開く
- [Export Bookings]をクリックして予約情報一覧が入ったCSVファイルをダウンロードする
- Googleのスプレッドシートを開く
- [ファイル]→[開く]をクリック
- [アップロード]タブをクリックし、ダウンロードしたCSVファイルを選択する
- [開く]をクリックすると予約情報一覧がスプレッドシートに表示される
【APIを活用した場合】
- 【初回のみ】APIを使うためのプログラムを書き、毎日自動実行されるように設定する
- 毎日決まった時間にBeds24から最新の予約情報一覧を自動ダウンロードし、スプレッドシートに反映される
手動で行う場合に比べて、APIを活用すると明らかに手間が減ります。初回の設定さえすれば、あとは毎日自動的にプログラムが処理を行ってくれます。
デメリットはプログラムを書くハードルが高いため、どのように設定すればいいかわかりにくいことです。
ですがご安心ください！
今回のシリーズ記事を通して、コピペするだけで使えるプログラムや設定方法を順を追って紹介します。
API連携の第一歩！Beds24のAPIキーを発行する方法
まず第一歩としてBeds24のAPI Key (APIキー) を発行します。
APIキーとはAPI連携するためのパスワードのようなものです。5分もあれば簡単に発行できます。
手順を見ていきましょう。
[Settings]を開く
Beds24にログインし、画面上部の[Settings]をクリックしてください。
[Account Access]を開く
画面左の[Account] → [Account Access]をクリックしてください。
パスワードを入力する
パスワードの入力を求められるので、Beds24のログインパスワードを入力し[Continue]をクリックしてください。
各種情報を入力&選択する
画面をスクロールすると[API Key 1]という欄があります。
その中にいくつか項目がありますので、入力や選択を行います。
1. API Key
この項目がAPIキーです。
16～64桁のランダムな英数字をご自身で決めて入力してください。
決めにくい場合は以下のようなパスワードジェネレーターを使用すると便利です。
1password.com
APIキーはみなさんのBeds24アカウントにアクセスするためのパスワードのようなものです。他人やウェブ上に公開しないようにご注意ください。
なお、設定後にこのページに来ればいつでもAPIキーを確認できます。
2. API Key Access
API連携を許可する条件を設定できます。
- disabled: 正しいAPIキーを使用したとしてもAPI連携を許可しない
- allow whitelist IP only: 特定のIPアドレスからのみAPI連携を許可する
- allow any IP: どのIPアドレスからでもAPI連携を許可する
[allow whitelist IP only]を使用するとよりセキュリティが高いですが、固定IPアドレスをお持ちでなかったりそもそもよくわからなかったりする場合、[allow any IP]を選択すればOKです。
3. IP Whitelist
(2)で[allow whitelist IP only]を選択した方はこちらにAPI連携を許可するIPアドレスを入力してください。
(2)で[allow any IP]を選択した方はここは空欄のままでOKです。
4. Allow Writes
API連携を使用してBeds24のデータを編集できるかどうか設定します。
Beds24のAPI連携は「Beds24⇒外部アプリケーション」の一方通行ではなく、外部アプリケーションからBeds24のデータを編集することも可能です。
例えば外部アプリケーションからBeds24の料金を変更する、という使い方も可能です。
- Yes: Beds24のデータを編集できるようにする
- No: Beds24のデータを読み取りだけできるようにする
外部アプリケーションからBeds24のデータを編集したい方は[Yes]を選択してください。
「Beds24の予約情報一覧をGoogleスプレッドシートに反映させる」のようにBeds24の情報を読み取るだけの場合、[No]を選択してください。
慣れないうちは予期せぬトラブルを避けるため[No]を選択することをおすすめします。
5. Property Access
オーナー権限をもつPropertyにのみAPI連携できるのか、もしくはアクセス権があるすべてのPropertyに対してAPI連携できるのかを設定します。
- Owned by this account only: オーナー権限をもつPropertyにのみAPI連携できます
- Owned or linked to this account: アクセス権があるすべてのPropertyに対してAPI連携できます
よくわからない場合、[Owned or linked to this account]を選択すればOKです。
※Propertyのオーナー権限ってそもそも何？という方は以下記事をご覧ください。
www.yukibnb.com
初心者の方のおすすめ設定はこのようになります。
[Save]をクリックしてAPIキーの設定完了！
1～5を入力&選択できたら最後に[Save]をクリックして保存してください。
これで無事APIキーの設定が完了です！
まとめ
今回はBeds24と外部アプリケーションをAPI連携するためのシリーズ第1段として、「APIとは何か？」やBeds24のAPIキーの発行方法を紹介しました。
今後複数記事に渡って、コピペするだけで使えるプログラムや設定方法をご紹介します。
API連携を活用して、便利なBeds24をもっと便利で効率的なものにしましょう！
【2020/2/24更新】
API連携シリーズ、次回記事を公開しました。
