レスポンスに含まれる項目
IBGE の地域 API から27の連邦単位を読み込み、id、略称、名称、地域を一つの一覧で比べられます。
この一覧は地域表記の統一には役立ちますが、住所、自治体、郵便番号、配送地域、電話の市外局番、居住地、個人の現在地を確認するものではありません。具体的な用途では、目的に合う情報源と完全な地点情報を使ってください。
確認したい項目
- id: 連邦単位のコード
- sigla: 2文字の略称
- nome: 連邦単位の名称
- regiao: id、略称、名称
IBGE Estados
IBGE の地域 API から27の連邦単位を読み込み、id、略称、名称、地域を一つの一覧で比べられます。
現在の公開データ
一覧を読み込み、id、sigla、nome、regiao を合わせて確認します。すでに id が分かる単位は、ドキュメントにある /api/v1/localidades/estados/{id} でも確認できます。
各レコードの内容
州の一覧は27の連邦単位を返します。各レコードの id は API が使う数値コード、sigla は2文字の UF 識別子、nome は名称です。regiao オブジェクトには、その単位が属するブラジル地域の別の id、sigla、nome があります。
- 州の id と regiao 内の id を混同しないでください。
- GO や SP のように UF を求める項目では sigla を使います。
- 表示には nome、連携で API コードが必要な場合は id を使います。
単位を調べる方法
このページのボタンは一覧全体を読み込むため、略称を名称と地域の横で確認できます。id が分かっている場合は、IBGE のドキュメントにある /api/v1/localidades/estados/{id} を使えます。たとえば 52 は Goiás を返します。
- 識別子をコピーする前にレコード全体を比べます。
- 名称で単位を探し、同じ項目で略称を確認します。
- id のルートは提供元からコードを得た後に使います。
分類の限界
応答の地域は IBGE による地域分類です。個人の居住地を示さず、距離を計算せず、完全な住所、郵便番号、自治体検索の代わりにもなりません。物流、対応、登録では、州の参照と場所に特化した情報源を組み合わせてください。
- UF の略称から自治体や地区を推測しないでください。
- 配送地域の確認に一覧を使わないでください。
- 住所は具体的な用途に合う情報源で確認します。