開発手順

KSAS APIを用いたアプリケーションを開発するための手順をご紹介します。
なお、KSAS API経由で農家様のデータを取得するには、データ連携ご希望の農家様が、事前に『他社アプリ連携アカウント※』を作成する必要があります。

※『他社アプリ連携アカウント』はKSASの契約照会・変更メニューにて設定できます。
　農家様の情報をKSAS以外のアプリケーションに提供するためのアカウントであり、農家様ご自身で作成が必要です。

1.OAuth2.0認証に必要な情報を取得する

KSAS APIを使用するにはOAuth2.0の認可コードフローによるアクセストークンの取得が必要です。
アプリケーションの作成やアクセストークンの取得に必要な、以下の情報を希望する方は、
KSASサービスデスク(ページ下部参照)までお問い合わせください。

・OAuth2.0認証に必要なアプリケーションIDやシークレットの情報
・APIドキュメントの閲覧に必要なKSAS Developersへのサインイン情報
・アプリケーション動作確認用環境へのアクセス方法

2.API仕様を確認する

KSAS Developersへのサインイン後に表示される『APIドキュメント』のページには、KSAS APIのAPI仕様が記載されています。
アプリケーション作成にご利用ください。

3.アプリケーションを作成する

KSAS APIを利用したアプリケーションを作成します。
KSAS APIのコール時にはアクセストークンをAuthorizationヘッダーに含める必要があります。

4.アプリケーションの動作確認を行う

動作確認用環境を利用して、アプリケーションの動作確認を行います。
動作確認用環境では、営農支援情報を模したテストデータの取得や、
本番環境と同等のステータスコードを返却することで動作確認が可能です。
※動作確認用環境では農家様の実データを取得することはできません。

5.本番環境用アプリケーションIDを取得する

本番環境は動作確認用環境とは別のアプリケーションID、アクセストークンの取得が必要です。

6.アプリケーションを公開する

本番環境では、KSASにて他社アプリ連携アカウントを作成し、営農情報のデータ連携を有効にした農家様が、
アプリケーション内でサインイン処理を行うことで、当該農家様の営農情報を取得可能です。