APIの仕様を確認する

1. APIの仕様を確認する

API開発者ポータルメインページに、個人ユーザ向けAPIと法人ユーザ向けAPIを準備しております。確認したいAPI種別を選択してください。

2. APIの仕様をダウンロードする

APIの仕様はOpenAPI Specification(Swagger) 2.0で記述しています。
独自に拡張している一部項目はWeb画面では表示されないため、より詳細な仕様を確認する場合は、API仕様ページ上部の [Download] ボタンから仕様ファイルをダウンロードしてください。

APIリクエストを試す

API利用情報を取得することで、API開発者ポータルのAPIシミュレータ環境を利用することができます。
API利用情報には、APIシミュレータ環境利用時に必要となるクライアントIDやクライアントシークレット、レスポンスデータのパターン等が記載されています。

1. 「API利用情報」ページにアクセスする

APIの情報を公開しているAPI利用情報ページにアクセスします。

2.  API利用情報をダウンロードする

API利用情報ページにはダウンロード可能な情報の一覧が表示されます。
利用したいAPIのAPI利用情報(Excelファイル)をダウンロードしてください。

APIシミュレータ環境のデータパターンは随時更新されます。
APIシミュレータ環境をご利用の際は、適宜、最新版のAPI利用情報(Excelファイル)をダウンロードしていただけますようお願いいたします。

3. APIリクエストをする

OpenCanvasのAPIはOAuth2.0のAuthorization Code Flowを採用しています。
取得したクライアントIDやアクセストークンを用いてAPIリクエストをしてください。
APIシミュレータ環境のAPIはcurl等のツールを用いて、お手持ちの端末からリクエスト可能です。

商用接続に向けた対応

商用接続にあたりましては、別途弊社との仕様開示契約後に、仕様書にて仕様※を確認いただく必要がございます。
詳細につきましては弊社までお問い合わせください。

※APIの仕様以外の、センタ運用時間や商用のアクセス先URIについてご確認いただくことを目的としています。