1.概要
本ポータルではAPIを利用し、当社システムとの接続を検討される事業者さまが、当社が提供するAPIの仕様を確認することができます。
また、APIの簡易なテストができるテスト環境をご利用できます。
API以外の詳細な仕様※はお手続き後に開示いたします。詳細はこちらからお問合せください。
※APIの仕様以外の、センタ運用時間やアクセス先URI、通信シーケンスやインターフェース、画面遷移を確認いただけます。
2.APIの仕様確認
2-1.APIの仕様を確認する
トップ画面または画面上部のAPIメニュータブからご利用対象のAPIを選択し、仕様をご参照ください。
ご利用いただけるAPI一覧については、各サービスのAPI機能メニュー又はAPI詳細よりご確認いただけます。
よく利用される機能メニュー
2-2.APIの仕様をダウンロードする
APIの仕様はOpenAPI Specification(Swagger) 2.0で記述しています。
独自に拡張している一部項目はWeb画面では表示されないため、より詳細な仕様を確認する場合は、
API仕様ページ上部の [Download] ボタンから仕様ファイルをダウンロードしてください。
3.APIリクエストを試す
3-1. 「テスト環境」ページにアクセスする
テスト環境ページにアクセスします。
3-2. テスト環境情報をダウンロードする
テスト環境ページにはダウンロード可能な情報の一覧が表示されます。
利用したいAPIのテスト環境情報(Excelファイル)をダウンロードしていただくことで、簡易的な試験の実施が可能です。
■テスト環境情報のご確認方法と注意事項
・各ファイル内に「ご利用方法」や「制約事項」が記載されていますので、ご確認の上、試験実施をお願いします。
・APIテスト環境利用時に必要となるクライアントIDやクライアントシークレット、レスポンスデータのパターン等が記載されています。
・APIテスト環境のデータパターンは随時更新されます。
ご利用の際は、適宜、最新版のテスト環境情報(Excelファイル)をダウンロードしていただけますようお願いいたします。
3-3. APIリクエストを実行する
OpenCanvasのAPIはOAuth2.0のAuthorization Code Flowを採用しています。
取得したクライアントIDやアクセストークンを用いてAPIリクエストをしてください。
APIシミュレータ環境のAPIはcurl等のツールを用いて、お手持ちの端末からリクエスト可能です。
4. 商用利用に向けた仕様確認
別途弊社との仕様開示契約後に、仕様書にて仕様※を確認いただく必要がございます。
詳細につきましてはこちらからお問合せください。
※APIの仕様以外の、センタ運用時間や商用のアクセス先URI、通信シーケンスやインターフェース、画面遷移を確認いただけます。
5. よくある質問の確認
不明点については、まずよくあるご質問をご確認ください。