• TOP
  • API利用の手引き

API利用の手引き

ご利用の流れ

Step01

利用規約を確認する

Safie APIをご利用いただくため、利用規約をご確認ください。

API利用規約

Step02

利用を申請する

お問い合わせフォームに入力の上、利用申請を行ってください。

お問い合わせ

Step03

ClientID(クライアントID)の発行

弊社より、開発のために必要な情報(ClientID・ClientSecret)を発行します。開発元(APIを利用してサービスを提供する提供者)単位での発行となります。

Step04

開発を進める

APIの仕様ドキュメントを公開していますので、ご活用ください。

APIドキュメント

Safie API 基本動作

ClientID・ClientSecretが発行されましたら、それらを利用してAPIを呼び出します。その際はアクセストークンが必要となります。アクセストークン取得についての詳細はAPIドキュメントをご参照ください。

Safie APIはサーバ間連携を前提としており、ブラウザから直接呼び出しに関しては対応しておりません。

基本動作サンプル

デバイス一覧取得APIのサンプルを以下に記載します。APIを呼び出す基本動作についてご確認ください。

curl —location —request GET ‘https://openapi.safie.link/v1/devices?item_id=お渡ししたオプションID’ \
—header ‘Authorization: Bearer 取得したアクセストークン’ \

# {
#   “total”: 1,
#   “offset”: 0,
#   “count”: 1,
#   “has_next”: false,
#   “list”: [
#       {
#            “device_id”: “デバイスID”,
#            “serial”: “シリアルNo.”,
#            “setting”: {
#                “name”: “デバイス名”
#            },
#            “model”: {
#                “description”: “モデル名”
#            },
#            “status”: {
#                “video_streaming”: false
#            }
#        }
#    ]
# }
  • 取得したアクセストークンを利用しデバイス一覧取得APIを呼び出します。
  • 必要に応じてパラメータを設定してください。
  • デバイス一覧取得APIで取得したデバイスIDを元に他のAPIを呼び出すことができます。

お困りのときは

Safie API の使い方や開発環境についてなど、ご利用に関してのよくあるご質問とその回答(FAQ)をまとめています。ご活用ください。

よくあるご質問