REST API

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

RADIUSaaS は REST API を公開しており、RADIUSaaS 管理ポータル UI を通じて行う必要があるほとんどの操作を自動化できます。

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

認証

REST API への呼び出しを認証するには、HTTP Authorization ヘッダーを各リクエストに設定します。このヘッダーには有効な access token:

Authorization: Bearer
               <Access Token>

API リファレンス

API ドキュメントには、各 API エンドポイントの完全な Swagger ベースの API リファレンスが含まれており、

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

• HTTP レスポンスコード、

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

• レスポンスボディの JSON スキーマ、および

• 一部エンドポイントのリクエスト・レスポンス例。

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

シナリオ

BYOD やゲストアクセスのためのユーザー名/パスワードアカウントの管理

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

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

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

外部監視の実装

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

外部監視

cURL の例

一般に、REST API にはフォームデータまたは JSON の 2 種類のコンテンツタイプがあります。どのメディアタイプが必要かは 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'