REST API

REST API のドキュメントは https://YOURNAME.radius-as-a-service.com/docs/api で利用できます

RADIUSaaS は REST API を公開しており、RADIUSaaS 管理ポータル UI を通じて行わなければならないほとんどの操作を自動化できます。

構成変更を引き起こす API 呼び出しを実行する前に、その影響を十分に理解していることを確認してください。API の誤用はサービスの構成を破壊する可能性があります。

認証

REST API への呼び出しを認証するには、HTTP ヘッダーに次を設定してください。 Authorization このヘッダーには有効なトークンを含める必要があります。 アクセス トークン:

Authorization: Bearer
               <アクセス トークン>

API リファレンス

API ドキュメントには、各 API エンドポイントに関する完全な Swagger ベースの API リファレンスが含まれており、次の情報が記載されています。

• 利用可能な HTTP メソッド、

• HTTP 応答コード、

• リクエスト（ボディ）用の JSON スキーマ / フォームデータ、

• レスポンスボディの JSON スキーマ、そして

• 一部のエンドポイントに対するリクエスト - レスポンスの例。

API リファレンスから直接 API 呼び出しをトリガーすることはできません。

シナリオ

BYOD またはゲストアクセス向けのユーザー名/パスワード アカウントの管理

REST API は、BYOD やゲストアクセスのシナリオでのユーザー名/パスワード アカウントの管理を自動化するために使用できます。

これには、新しい学生やコワーキングスペースの入居者などのオンボーディング時に（WiFi）資格情報を自動的にプロビジョニングすることや、それらのアカウントを自動的に削除することが含まれる場合があります。

ユーザー名/パスワード アカウントをプロビジョニングするための REST API の使用例は、API リファレンスの ユーザーは エンドポイントにあります。

外部監視の実装

外部システムで RADIUSaaS インスタンスのサービス可用性や稼働時間を監視したり、RADIUS サーバー証明書の有効期限を監視したりするには、次のガイドを参照してください：

外部監視

cURL の例

一般に、REST API にはフォームデータまたは JSON のいずれかのコンテンツタイプがあります。どのメディアタイプが必要かは API ドキュメントで確認できます。

curl 構文に不慣れな場合は、ここに 2 つの例があります：

JSON

curl -X "METHOD" "https://YOURNAME.radius-as-a-service.com/api/ROUTE/PATH" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -H 'Content-Type: application/json' \
    -d $'{
            必要な JSON データ。ドキュメントを参照してください
        }'

フォームデータ

curl -X "METHOD" "https://YOURNAME.radius-as-a-service.com/api/ROUTE/PATH" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -F 'KEY=VALUE'\
    -F 'KEY=VALUE'