本文へスキップ

API認証

BioStar Air Cloud APIはBearerトークン(JWT)ベースの認証を使用します。 APIを呼び出す前にログインしてトークンを取得し、すべてのリクエストのAuthorizationヘッダーにトークンを含める必要があります。

APIベースURL

環境Base URL説明
Demo(TEST)https://sp-demo-api.airfob.com/v1アプリケーションの種類を「Demo」として登録すると、デモ環境のサイトとサイトマスターのアカウント情報をCSVファイルでダウンロードできます。
Production(LIVE)https://sp-api.airfob.com/v1自動ルーティング)クライアントの地域に応じて、グローバルまたはEUのサーバーを自動で選択します。
https://sp-a-api.airfob.com/v1グローバル専用)グローバルサーバー環境に接続されます。
https://sp-e-api.airfob.com/v1EU専用)EUサーバー環境に接続されます。

自動ルーティング環境では、地域検出により予期しないルーティング(routing)が発生することがあります。

APIログイン手順

Postman またはプログラムからAPI呼び出しを行うことができる。

ログイン

  • Endpointlogin

  • Payload

    {
    "username": "your_email",
    "password": "your_password"
    }

Bearerトークン(JWT)を返す。

アカウント情報の取得

  • EndpointgetSelfAccounts

  • Authorization:Bearer Token

アクセス可能なサイトおよびアカウントの一覧を返す。

アカウントにログイン

  • EndpointloginAccount

  • Authorization:Bearer Token

特定サイトのトークンを返す。

ウェブブラウザでBearerトークンを取得する方法

Postmanを使わずに、ブラウザの開発者ツールで直接Bearerトークンを取得できます。

Chrome/Edge(WindowsまたはMac)

  1. ウェブブラウザでF12またはCtrl/Cmd + Shift + Iを押す。

  2. Network タブに移動する。

  3. ページをリロードする。

  4. API呼び出しを検索する。

    例: groups, login

  5. リストからリクエストをクリックする。

  6. Headers」タブに移動する。

  7. リクエストヘッダでAuthorization: Bearer ...を探す。

  8. 右クリックしてトークンをコピーしてください。

Safari(Mac)

  1. 「開発者」メニューを有効にしてください。 Safari → Preferences → Advanced → Show Develop menuをチェックする。

  2. DevelopShow Web Inspector に移動する。

  3. Network タブに移動する。

  4. ページをリロードする。

  5. API呼び出しをフィルタリングして検査する。

  6. リクエストヘッダからAuthorization: Bearerトークンをコピーする。

情報

ブラウザからコピーしたBearerトークンはPostmanで再利用できる。 常に最新のBearerトークンを使用してください。

このページは役に立ちましたか?