導入ドキュメント
インターフェースの紹介
このインターフェイスは、特定の地域および商品カテゴリに基づいて農産物データを取得する機能を提供します。開発者は、製品名、地域名、およびオプションの日付を渡すことで、対応する市場参照情報を取得できます。複数箇所の農産物価格を統合する必要がある業務システムに適しています。
該当するシナリオ
- 農業電子商取引プラットフォーム: 地元の特産品農産物を推奨したり、ユーザーの位置に基づいてリアルタイムの参考価格を表示したりできます。
- 市場監視システム: さまざまな地域の特定の農産物に関するデータを自動的に収集し、価格傾向レポートを生成します。
- サプライチェーン調達: 調達担当者が異なる生産地域での農産物の供給を比較できるように支援します。
リクエストと返品の手順
- リクエストメソッド: POST
- コアパラメータ:
categoryName(必須): 「リンゴ」、「お米」などの商品名。region(必須): 地域名。「煙台、山東省」、「黒竜江省」など。date(オプション): クエリ日付、形式 yyyy-MM-dd、デフォルトは現在の日です。- 結果を返す: 地域とカテゴリに一致する農産物に関連するデータ オブジェクトを返します。特定のフィールド構造は実際の応答の影響を受けます。
提案へのアクセス
- パラメータ仕様: 照合精度を向上させるため、地域名には標準的な行政区画または共通の由来の別名を使用することを推奨します。
- キャッシュ戦略: 非リアルタイム要件が非常に高い表示シナリオの場合は、API 呼び出しの数を減らすために、同じリージョンおよびカテゴリのクエリ結果を短期間キャッシュすることをお勧めします。
- 例外処理: データが返されない状況を適切に処理してください。フロントエンドは、エラーを直接報告するのではなく、ユーザーフレンドリーなプロンプトを表示する必要があります。
実装サンプルコード
Shell、Python、Go、Java、PHP の呼び出し例をまとめ、既存プロジェクトに組み込みやすくしています。
リクエスト例
{
"categoryName": "商品名称",
"region": "地区名称",
"date": "日期,格式:yyyy-MM-dd,默认当天"
}レスポンス例
{}リクエスト項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | サンプル値 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.categoryName | object | {...} |
| properties.categoryName.type | string | string |
| properties.categoryName.description | string | 商品名称 |
| properties.region | object | {...} |
| properties.region.type | string | string |
レスポンス項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | サンプル値 |
|---|---|---|
| type | string | object |