この記事では、RICOH Spaces Open APIについて説明します。
それは何か
RICOH Spaces Open APIは、データを取り出して外部プロセスを実行したり、外部プロセスからデータを取り込んだりすることで、RICOH Spacesの現在の機能を拡張することを可能にします。これにより、RICOH Spacesの製品チームが統合機能を構築する必要がなくなり、企業が望むものを構築できるようになります。オープンAPIを使って構築できる機能の例としては、以下のようなものがあります：
RICOH SpacesにIoTデータを投稿することで、RICOH SpacesがサポートしていないデバイスからのIoTデータの取り込みを可能にします。
RICOH Spacesから予約データを取り出し、駐車ゲートなどの外部予約ツールに送信します。
RICOH Spacesから来訪データを取り出し、外部のエントリーバリアツールに送信。
RICOH Spaces APIの現在のすべての機能は、https://eu-cloud.ricohspaces.app/documentation にあります。
設定方法
カスタム機能を開発する前に、まずAPIキーを作成する必要があります。これはRICOH Spacesのテナント設定から行うことができ、グローバル管理者のみが作成できます。APIキーには名前を付けることができ、有効または無効にすることができます。APIキーは作成時に一度だけ見ることができ、その後は二度と取得できません。APIキーを紛失した場合は、新たにAPIキーを作成する必要があります。
これが作成されると、APIを操作できるようになる。データをプッシュまたはプルする前に、認証トークンを作成する必要があります。これは、以下で認証することで行うことができる。
認証
Open APIを利用する前に、アクセストークンを取得するための認証が必要です。これは、RICOH Spacesから取得したAPI Keyと、RICOH Spacesのサポートから提供されるクライアントIDを使用して、/auth/tokenエンドポイントを呼び出すことで行われます。
エンドポイント： POST /auth/token
ヘッダー：
api-key: あなたのAPIキー
クライアントIDあなたのクライアントID
レスポンス： 有効期限が1時間のJWTトークン。
使い方： トークンは、その後のすべてのAPIリクエストのためのBearerトークンとしてAuthorizationヘッダに含まれなければなりません。
API レスポンスには JWT トークンが含まれており、この JWT トークンをクライアント ID と共に使用することで、今後すべての API 呼び出しを実行できます。
バリデーション
認証が完了し、Open APIエンドポイントを使用すると、2つの方法でAPIコールが機能していることを確認できます。
成功したレスポンスとデータを受け取る
有効なレスポンスはすべて200のステータスコードと、Open API Documentationで定義されているデータ構造を返すべきである。
2.RICOH Spacesのアクティビティログを確認する。
APIキーのアクティビティはAPIキーのページから見ることができ、実行されたAPIコールのログ、日時、コールの発信元IPアドレスが表示されます。