Stayforge API

Copy page

Stayforge API

ドキュメントの大部分は現在英語で提供されています。 日本語版は現在翻訳作業中ですので、公開まで今しばらくお待ちください。

Stayforge API は Golang 製のバックエンドを採用しており、 Kubernetes ベースのオートスケーリングによって安定した運用を行っています。 通常の利用においては、99.5%* 程度の稼働率を目安としています。

*自社調査に基づく数値であり、サービス品質保証（SLA）として保証するものではありません。

Quck Start

本ガイドでは、最も使われるカード発行APIをいくつか紹介します。Stayforge APIの詳細については、「API仕様一覧」をご参照ください。

API仕様一覧

---

まず、APIKeyを取りましょう

Dashboardを開いて、そちらの手順でStayforgeアカウントを登録してください。

組織（Organization）とテナント（Tenant）の作成が完了しましたら、 [設定] > [APIキー]よりAPIキーを生成し、保存してください。

---

APIによるアクセスカードの管理

Stayforge APIを利用して、カードの発行、照会、削除、および更新を管理することが可能です。

カードは論理的に組織に帰属します。そのため、一つのカードに対して、複数の施設を跨いで紐付けることも可能です。 これにより、施設の枠を超えた柔軟なアクセス管理を実現します。

1. カードの発行

一つのカードに対して、複数のデバイスを紐付けることが可能です。

例えば、施設の入り口にオートロックがある場合、そのエントランスの device_id（stayforge-hotel-gateway） を devices フィールドに追加してください。 これにより、宿泊客は同じカードを使用して、エントランスと予約した客室の両方を解錠できるようになります。

構成イメージ

Code
 
curl --request POST \
  --url https://api.stayforge.net/v1/cards/:organization_id \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <your-api-key>' \
  --data '
{
  "display_name": "Room card 101",
  "devices": [
    "stayforge-hotel-101",
    "stayforge-hotel-gateway"  # The same card can be bound to multiple devices
  ],
  "effective_at": "2024-08-25T15:00:00+09:00"  # Make sure to set a timezone
  "invalid_at": "2024-08-25T15:00:00+09:00"
}

2. カード一覧の取得

Code
 
curl --request GET \
  --url https://api.stayforge.net/v1/cards/:organization_id \
  --header 'X-API-Key: <your-api-key>'

---

APIの使用方法や技術的な詳細については、API仕様一覧をご参照ください。

また、GitHubにてOpenAPIドキュメントを公開していますので、Githubからダウンロードいただけます。 https://github.com/stayforge/Stayforge-API

---

新しい API は Golang で再構築され、現在はベータ版として公開しています。 テストカバレッジは現在 78% ほどですが、まずは80%以上を目標にブラッシュアップを進めているところです。

もしバグを見つけたり、使い方がわからなかったりした場合は、お気軽に GitHub Issues で報告してください。 また、Discord サーバーでは開発メンバーと直接やり取りも可能ですので、ぜひ参加してみてください！

• Github Issues：https://github.com/stayforge/Stayforge-API/issues
• Discord：https://discord.gg/JYFEttnydq

---

Need Help?

Stayforge に関する質問、フィードバック、開発者同士の討論は、 公式 Discord サーバーでやってます！ よければご参加してください！