利用規約このサイトについてログインホームAPIここでは、本サイトで提供しているAPIについて説明します。グループAPIAPIについてデータセットAPIの利用方法データセットAPIの仕様データセットIDの一覧を取得(package_list)データセットのメタ情報(プロパティ)を取得(package_show)リソースのメタ情報(プロパティ)を取得(resource_show)データストアAPIの利用方法アプリケーションの登録・申請データストアAPIの仕様データストアを検索してレコードを取得(datastore_search)データストアのカラム名のルール退会APIについて本システムで提供しているAPIには下記の2種類があります。データセットAPIデータセットやリソースのメタデータ(プロパティ情報)を取得することができます。データセットAPIの利用には申請等は必要なく、誰でもすぐにご利用頂けます。データストアAPIリソースファイルをDB化したデータストアからデータをレコード単位で取得することができ、詳細な条件を指定した柔軟な検索が可能です。データストアAPIを利用するには、APIを利用するアプリの申請を行い、承認時に発行されるAPIキーとアプリIDが必要になります。データセットAPIの利用方法データセットAPIは、以下のエンドポイントに対して実行したいメソッドを指定してリクエストを送信することで、実行結果(レスポンス)をjson形式で取得することができます。https://opendatatoyohashi.jp/api/3/action/データセットAPIの仕様データセットAPIで使用可能なメソッドには下記の3つがあります。リソースIDを指定したリソースのメタ情報を取得するデータセットIDの一覧を取得(package_list)データセットのIDの一覧を取得する。一度に取得する件数を指定する。取得データの開始位置を指定する。ヘルプデータセットのメタ情報(プロパティ)を取得(package_show)データセットIDを指定したデータセットのメタ情報(データセット情報、関連タグ、リソース情報、グループ情報)を取得する。データセットIDを指定する実行例:package_show?id=29544f9f-16cc-428a-93a0-093378751f74package_showのリクエストURLとパラメータは取得したいデータセット詳細の下記図にあるその他のアクセス形式のリンクから取得することができます。ヘルプリソースのメタ情報(プロパティ)を取得(resource_show)リソースIDを指定したリソースのメタ情報を取得する。リソースIDを指定する実行例:resource_show?id=c0fdb1c1-bab5-4cf4-8006-da13b8b16a2bresource_showのパラメータとなるidは取得したいリソース詳細の下記図にある識別子の値をご使用ください。ヘルプデータストアAPIの利用方法データストアAPIは下記の流れでAPIを利用するアプリの申請を行い、承認されるとAPIエンドポイントとAPIキー、アプリIDが発行され、APIをご利用頂けます。下記の操作説明に従ってAPIを利用するアプリの情報を登録して、申請を行ってください。「一覧」をクリックします。アプリケーションの一覧では、今までに作成したアプリケーションを見ることができます。アプリを登録したい場合は、「新規作成」をクリックします。アプリ名と概要を入力、APIで使用するリソースを選択して、ステータスを承認待ちにして「保存」をクリックします。アプリの登録が完了すると、登録したアプリのページが表示されます。承認されていないため、APIキーはまだ発行されていません。登録したアプリが承認されると、以下のようなメールが届きます。記載されたURLをクリックすることで登録したアプリのページに移動します。アプリのページを確認すると、ステータスが公開になっており、APIキーも発行されていることが確認できます。利用できるリソースも表示されます。これで、データストアAPIを利用できる状態となりました。データストアAPIの仕様データストアAPIでは、指定した条件に合致するリソース(データストア)のレコードを取得することができます。レスポンスの出力形式にはxml、json、jsonpのいずれかを指定可能です。取得したいカラムをカンマ区切りで指定する。指定しない場合はすべてのカラムを取得する。SQLの条件式(=,>,>=,<,<=,!=)を指定する。位置情報で円による範囲検索をする場合に中心点を指定する。返却される距離のカラム名を指定する。デフォルトは“distance”で返却される。一度に取得する件数を指定する。取得データの開始位置を指定する。ヘルプデータストアのカラム名のルールデータストアのカラム名は半角英数字とハイフン(-)とアンダーバー(_)で構成されている必要があります。日本語が使用できないため、基本的には下記の対応表に基づいてカラム名がつけられております。infantsAPIの説明は以上です。データストアAPIを利用したい場合は以下のリンクから実際にアプリを申請してみましょう。https://opendatatoyohashi.jp/node/add/application次のページでは退会(アカウント削除)について説明します。