WebAPI ドキュメントについてのご案内

概要

本ドキュメントは、Swagger を利用して WebClass で使用できる WebAPI の詳細について記入したものです。
WebAPI の利用手順についての詳細は以下のブログにまとめています。ぜひご覧ください。
WebAPIの利用手順書

利用可能な環境

本 API は、WebClass の各サーバで利用できます。
基本の URL フォーマットは以下の通りです。
[土台のURL] https://サーバホスト/webclass/api.php/rest/

認証について

WebAPI を使用するには トークン認証 が必要です。
トークンの取得方法や利用方法については、WebClass サポートまでお問い合わせください。

バージョン情報

本 API は v11.14.7 以降のバージョンで使用可能です。

注意事項

• 「Tryout」で送信されるURLはモックサーバであり、実際に使用されるURLとは異なります。
• 「Tryout」のレスポンスは Mock データ に基づいており、パラメータによる制御は行なっていないため、実際の環境とは異なる場合があります。
• レスポンスの例は「Schema」を「Example Value」に切り替えることで確認が可能です。

本サービスでは以下のオープンソースソフトウェアを利用しています：

• Swagger UI (Licensed under Apache License 2.0)
• Stoplight Prism (Licensed under Apache License 2.0)

各ソフトウェアのライセンス条件に基づき、権利情報を表示しています。