REST API

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

RADIUSaaS は REST API を公開しており、RADIUSaaS Admin Portal の UI から行う必要があるほとんどの操作を自動化できます。

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

認証

REST API への呼び出しを認証するには、各リクエストに HTTP 認証 ヘッダーを含めます。このヘッダーには有効な アクセストークン:

Authorization: Bearer
               <Access Token>

API リファレンス

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

• 利用可能な HTTP メソッド、
• HTTP 応答コード、
• リクエスト（ボディ）の JSON スキーマ / フォームデータ、
• レスポンス本文の JSON スキーマ、および
• 一部のエンドポイント向けのリクエスト・レスポンス例が含まれます。

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

シナリオ

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

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

これには、新規学生やコワーキングスペースの入居者のオンボーディング時に (WiFi) 認証情報を自動でプロビジョニングすることや、それらのアカウントを自動で廃止することが含まれる場合があります。

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

外部監視の実装

外部システムを使用して RADIUSaaS インスタンスのサービス可用性と稼働時間を監視する場合、または RADIUS Server Certificate の有効期限を監視する場合は、次のガイドを参照してください。

外部監視

cURL の例

一般に、REST API には form data または 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'