API 概要

ゆめみフロントエンドコーディング試験用の API です。

本 API は、内閣府 地方創生推進室が提供している RESAS(地域経済分析システム) のデータを加工して作成しています。

※当該データは 2024 年 10 月時点のものであり、最新性を保証するものではありません。

API 詳細仕様

◎ エンドポイントについて

本 API のエンドポイントは https://frontend-engineer-codecheck-api.mirai.yumemi.io/ です。

◎ API キーの設定について

本 API へアクセスするには、API キーをリクエストヘッダー X-API-KEY に設定する必要があります。

リクエストヘッダーに有効な API キーが設定されていない場合、リクエストしたデータは返却されず、403 Forbidden のエラーが返されます。

※ 本 API は運用の簡素化を図るため、すべての応募者に共通の API キーを提供しております。

リクエストヘッダー API キー
X-API-KEY 8FzX5qLmN3wRtKjH7vCyP9bGdEaU4sYpT6cMfZnJ

◎ レスポンスヘッダーの Content-Type について

レスポンスヘッダーの Content-Type は application/json; charset=UTF-8 です。

◎ エラーについて

400 Bad Request

本 API に必要なパラメータが正しく設定されていない場合に発生します。

必須パラメータの設定が漏れていないか、正しいフォーマットで設定できているか、等をご確認ください。

403 Forbidden

リクエストヘッダーに API キーが存在しないか、指定された API キーが無効な場合に発生します。