全国道路施設データベース
公開⽤ API 基本仕様書

国⼟交通省

― ⽬次 ―

1. 本基本仕様書の⽬的及び概要 .............................................. 1
2. 公開⽤ API 基本仕様書の定義仕様項⽬ ..................................... 2
3. 公開⽤ API の定義 ....................................................... 3
API 接続⽅式 ....................................................................3
3.1.1. 通信プロトコル ................................................................3
3.1.2. REST 対応 ..................................................................3
3.1.3. エンドポイント(接続先 URL) ....................................................3
3.1.4. バージョンコード ...............................................................3
3.1.5. ⽇本語の⽂字コード ...........................................................3施設種類ごとのデータ項⽬ ..........................................................43.2.1. 施設種類ごとの ID について .....................................................43.2.2. 施設データの項⽬(パラメータ)名⼀覧 ..............................................4リクエスト ........................................................................4
3.3.1. データの参照 API .............................................................4
3.3.2. 物理ファイルの取得 API（例︓EXCEL による点検様式等の付属ファイル） ................4
レスポンス .......................................................................4
3.4.1. JSON 形式のデータ ...........................................................4
3.4.2. ファイル出⼒ .................................................................5
3.4.3. エラーレスポンス ...............................................................7API ⼀覧........................................................................83.5.1. データ参照 API 一覧 .........................................................8(1) 施設データの参照 API.........................................................83.5.2. 付属ファイル(物理ファイル)の取得 API 一覧 ...................................8各 API において指定するパラメータ ....................................................93.6.1. 施設データの参照 API のパラメータ ...............................................9(1) 施設データ参照 API............................................................9(2) 当該施設の最新基礎情報参照 API ..............................................11(3) 施設データ⾼度検索 API.......................................................113.6.2. 付属ファイル（物理ファイル）の取得 API のパラメータ ................................13(1) 第 77 条点検報告書様式ファイル取得 API ........................................13(2) 付属ファイルリスト取得 API .....................................................13(3) 付属ファイル取得 API ..........................................................14
パラメータの定義における留意事項 ...................................................153.7.1. パラメータ構造...............................................................153.7.2. パラメータ名.................................................................153.7.3. 選択肢 ....................................................................153.7.4. 複数年データ ...............................................................153.7.5. ⽇付表記の統⼀ ............................................................15
利⽤制限 ......................................................................16
利⽤申請 ......................................................................16
認証機能 .....................................................................163.10.1. API キー⽅式 ..............................................................16
利⽤規約 .....................................................................16

4. ⽤語集................................................................. 17

1. 本基本仕様書の⽬的及び概要
公開⽤ API 基本仕様書は、「全国道路施設データベース」において、オンラインにて提供する道路構造物に関する諸元や点検データ、交通量データ等をデータ参照するための API に関する基本仕様書です。
公開⽤ API 基本仕様書は、以下の 3 点の資料で構成しています。
・基本仕様書（本書）・提供するデータ項⽬のパラメータ⼀覧
・API リファレンスサンプル「基本仕様書」は、上記 API の基本的な記述仕様を⽰すものとします。
（2019 年 3 ⽉ 28 ⽇ API テクニカルガイドブック((内閣官房情報通信技術(IT)総合戦略室))に準拠）「提供するデータ項⽬のパラメータ名⼀覧」は API にて扱うデータ項⽬のパラメータ名を⽰すものとします。
（ただし、施設データに関するデータ項⽬はあくまで道路法第 77 条相当の項⽬までとしているため、左記以外のデータ項⽬を本 API にて取り扱う場合は、本基本仕様書のルールに準じて新たにパラメータ名を定義されることを想定します）「API リファレンスサンプル」は、API による呼出しや実⾏結果の詳細仕様例のサンプルを⽰すものとします。
尚、「API リファレンスサンプル」の概要を 4.リファレンスサンプルの概要に⽰します。
公開⽤ API を利⽤する参照⽤アプリにおいては、以下に⼤別した区分を想定した API としています。
・参照⽤アプリ(無償)・参照⽤アプリ(有償)・参照⽤アプリ(⾮公開)
参照⽤アプリ(有償)、参照⽤アプリ(⾮公開)にて利⽤する API のセキュリティ対策については、取り扱う情報の機密性を確保するために API キー⽅式を採⽤しています。

1

2. 公開⽤ API 基本仕様書の定義仕様項⽬
本公開⽤ API 基本仕様書における定義項⽬は以下のとおり。
項題名

内容

3.1

API 接続⽅式

API の接続プロトコル等の仕様

3.2

施設種類ごとのデータ項⽬

施設種類ごとのデータ項⽬等の仕様

3.3

リクエスト

API 呼び出し時のパラメータ等

3.4

レスポンス

API 呼び出し結果の仕様

3.5.

API ⼀覧

公開⽤ API における API 機能の⼀覧

3.6

各 API において指定するパラメータ

3.5、3.6 の API において指定するパラメータの定義

3.7

パラメータの定義における留意事項

3.7 のパラメータの定義における留意事項

3.8

利⽤制限

API の利⽤を制限する場合の仕様

3.9

利⽤申請

認証を要する API を利⽤するための必要な申請について

3.10

認証機能

API にて採⽤する認証⽅式について

3.11

利⽤規約

API を利⽤する上での利⽤規約

2

3. 公開⽤ API の定義
API 接続⽅式
3.1.1. 通信プロトコル
セキュアな HTTP プロトコルである HTTPS によって通信を⾏う。
API を設置するサーバは TLS(SSL)対応を必須とする。TLS のバージョンは 1.2 以降とする。
3.1.2. REST 対応
本 API のデータ参照様式は、REST(記述⽅式)に則った仕様を基本とする。
3.1.3. エンドポイント(接続先 URL)
接続先の URL は以下の仕様とする
https://{API 設置サーバのドメイン}/xROAD/api/{バージョンコード}/{リソース名}?{検索条件}
リソース名とは参照するデータの種類を表し、リソース名の後ろに検索条件を記述するものとする。
各施設種別の基礎情報（無償提供部分）の公開情報に関する接続先 URL を下表に⽰す。
施設種別

接続先 URL

道路橋

https://road-structures-db.mlit.go.jp/xROAD/api/v1/bridges

トンネル

https://road-structures-db.mlit.go.jp/xROAD/api/v1/tunnels

シェッド

https://road-structures-db.mlit.go.jp/xROAD/api/v1/sheds⼤型カルバート

https://road-structures-db.mlit.go.jp/xROAD/api/v1/culverts

横断歩道橋

https://road-structures-db.mlit.go.jp/xROAD/api/v1/pedestrian_decks

⾨型標識等

https://road-structures-db.mlit.go.jp/xROAD/api/v1/overhead_signages

舗装

https://road-structures-db.mlit.go.jp/xROAD/api/v1/pavements

特定道路⼟⼯構造物

https://road-structures-db.mlit.go.jp/xROAD/api/v1/earthworks

標識

https://road-structures-db.mlit.go.jp/xROAD/api/v1/signages

照明

https://road-structures-db.mlit.go.jp/xROAD/api/v1/lightings

検索条件の内容については後述する。
なお、各施設種別の詳細情報（有償）の接続先 URL 等については、契約完了後に管理団体から送付する（『データ利⽤までの流れ』参照）。
3.1.4. バージョンコード
バージョンコードは頭⽂字 v + バージョン数字とし、エンドポイントに含めて記述される。
例えばバージョン 1 なら「v1」と記述する。
3.1.5. ⽇本語の⽂字コード
本 API を利⽤した通信上で、⽇本語を扱う場合は、⽂字コードは UTF-8 とする。

3施設種類ごとのデータ項⽬
3.2.1. 施設種類ごとの ID について
本 API による施設データの参照は、施設の種類ごとにサーバが異なるため、URL を分別する。
以下に URL 内にて、施設の種類を区別するための ID を⽰す。
ID

意味

bridge道路橋

tunnel

トンネル

shed

シェッド

culvert

⼤型カルバート

pedestrian_deck

横断歩道橋

overhead_signage

⾨型標識pavement

舗装

earthwork

道路⼟⼯構造物(⼤型カルバートを除く)

signage標識

lighting

照明

3.2.2. 施設データの項⽬(パラメータ)名⼀覧
別紙「API データ項⽬名⼀覧」を参照
リクエスト
3.3.1. データの参照 API
REST の仕様に則って、GET メソッドを⽤いてデータの参照を⾏う。
⼀部の API は POST メソッドを⽤いる(理由は後述)
3.3.2. 物理ファイルの取得 API（例︓EXCEL による点検様式等の付属ファイル）
GET メソッドを⽤いて API にアクセスし、ファイルのダウンロードを⾏う。
レスポンス
3.4.1. JSON 形式のデータバイナリファイル(上記 3.3.2 にて取得する物理ファイル)以外は、JSON 形式の⽂字列として、以下のデータを返す。

 metadata
API の内容やリクエスト情報など

 resultset
検索結果の件数や 1 ページのデータ数など

 result
参照に成功した場合は参照したデータを、失敗した場合はエラーの内容を含んだ処理結果を返す。
上記の要素を下表に再掲する。
4No.

区分

1

metadata

パラメータ名title

必須内容◯

データの内容を⽰すタイトル

2

detail3parameter◯

リクエスト時に渡されたパラメータ

is_error◯

処理にエラーがある場合は true。ない場合は false

4

resultset

データの内容説明

5error_title

エラーのタイトル。is_error が true の場合は必須

6error_detail

エラーの詳細7

count対象データの件数

8

limit

⼀度に参照するデータ数の上限

9offsetデータ参照開始位置

─

結果データ

10

result

レスポンス例{"metadata":{"title": "橋梁データ⼀覧","detail": "橋梁データの⼀覧","parameter": {"area": "35.35,35.44,139.35,139.46"}},"resultset":{“is_error”: false,"limit": 25,"offset": 0,"count": 4},"result":{(施設データ)}3.4.2. ファイル出⼒
バイナリ形式のファイルは、HTTP の仕様(RFC6266)に準じて、ファイルの種類に合ったレスポンスヘッダを出⼒した上で、続けてバイナリデータを送信する。

5

6

3.4.3. エラーレスポンス
処理中に致命的なエラーが発⽣した場合、適切な HTTP レスポンスコードとエラー内容を JSON 形式で返す。
No.

レスポンスコード内容

1400

リクエスト内容に問題有り

2401

認証エラー

3404

存在しない API にアクセスされた

4429

⼀定時間内のアクセス数超過

5500

サーバ内部エラー

6503

メンテナンス中

レスポンスボディ(本⽂)に JSON 形式でエラーな内容を記述する。
No.

パラメータ名

内容

1

code

HTTP レスポンスコード

2

message

エラーの詳細な内容

レスポンス例{"code": 400,"message": "検索範囲が⽇本国内を超えています"}7

API ⼀覧
3.5.1. データ参照 API 一覧
データ参照 API の⼀覧を以下に⽰す。尚、各 API にて指定する具体的なパラメータは 3.6 に⽰す。
(1) 施設データの参照 API
No.
12

3

名称

記述規則

内容

施設データ

/{施設種類 ID}s?検索条件

施設データの過去分を含めた簡易

簡易参照 API例) /bridges?検索条件

な検索

最新施設データ/{施設種類 ID}s/lastest?検索条件

最新の施設データの簡易な検索

簡易参照 API例) /bridges/lastest?検索条件

施設データ/{施設種類 ID}s/search

⾼度な条件で施設データの⾼度参照 API

詳細な条件による検索検索条件は後述する。
詳細な検索条件式は「検索条件」に記述する。
3.5.2. 付属ファイル(物理ファイル)の取得 API 一覧
No.

名称検索条件内容

１

第 77 条点検調/{施設種類 ID}/report77/{施設 ID}/{年度}

施設 ID と年度を指定して、77 条調書様式ファイル取例) /bridge/report77/35.2134,139.112/2020/

査様式ファイル(※)のダウンロード

得 API※国交省 HP「道路の⽼朽化対策」に掲載の道路橋等の記録様式

2

付属ファイル/{施設種類 ID}/otherFileList?{検索条件}

リスト取得 API例

付属ファイルをダウンロードする必要が)/bridge/otherFileList?shisetsu=35.1234,130.1

ある場合に、ダウンロード対象のファイルリストを取得する

2345
3

付属ファイル/{施設種類 ID}/otherFile/{ファイル ID}

取得 API

例ファイル ID に紐付いたファイルをダウン)/bridge/otherFile/35.2134,139.112/7654321

ロード
複数ファイルがある場合は複数回実⾏

8

各 API において指定するパラメータ
3.6.1. 施設データの簡易参照 API のパラメータ(1) 施設データ簡易参照 API
指定した検索条件にマッチする施設データを過去分も含めてすべて参照する。
検索条件はクエリパラメータとして設定する。
パス: {施設種類 ID}s
メソッド︓GETNo.

パラメータ

内容

施設データの参照する

省略時

基礎項⽬パラメータ名
1shisetsu

施設 ID

shisetsu_id

すべての施設234

prefcityarea

都道府県コード指定

syogen.gyousei_kuiki

すべての都.todoufuken_code

道府県syogen.gyousei_kuiki

すべての市.shikuchouson_code

区町村

東⻄南北端の座標を指定し、範囲内の施

北端・南端︓すべての範設を抽出する。南端緯度、北端緯度、⻄端syogen.kiten.ido

囲市区町村コード指定

経度、東端経度を 10 進法表記のカンマ区

5

name

切りで記述。順序は⾃由だが、⽇本国内を東端・⻄端︓

外れる座標を指定するとエラーとなる。

syogen.kiten.keido

施設名に指定キーワードを含む施設データをsyogen.shisetsu.meis

すべての施抽出。

you

設名

施設名フリガナに指定キーワードを含む施設

syogen.shisetsu.furig

すべてのフリデータを抽出。キーワードは URL エスケープが

ana

ガナ

tenken.nendo

すべての年

キーワードは URL エスケープが必要。
6

furigana

必要。
7nendo

指定年度が合致する施設データを抽出

度
8limit

⼀度に参照する施設データの件数を指定

─100 件

9offset検索結果の参照開始位置を指定

─0

表 3.6.1 簡易参照 API における検索条件パラメータ9検索 URL サンプル集(ドメインは仮称)
千葉県の 2020 年度の橋梁のデータを検索
GET https://www.example.go.jp/xROAD/api/v1/bridges?pref=12&nendo=2020

北緯 35.35〜35.44 東経 139.35〜139.46 に囲まれた範囲で橋梁のデータを検索
GET https://www.example.go.jp/xROAD/api/v1/bridges?area=35.35,35.44,139.35,139.46「蔵前」というキーワードを施設名に含む橋梁のデータを検索
GET
https://www.example.go.jp/xROAD/api/v1/bridges?name=%E8%94%B5%E5%89%8D%E6%A9%8B

10(2) 当該施設の最新基礎情報簡易参照 API
指定した検索条件にマッチする施設データを最新の基礎情報のみ参照する。
検索条件は前項の施設データ参照 API と同じ。
パス: {施設種類 ID}s/lastest
メソッド︓GET
使⽤例(ドメインは仮称)
北緯 35.35〜35.44 東経 139.35〜139.46 に囲まれた範囲で最新の橋梁データを検索
GET https://www.example.go.jp/xROAD/api/v1/bridges/lastest?area=35.35,35.44,139.35,139.46

Web 地図上にアイコンを表⽰する場合などに使⽤できる。
(3) 施設データ⾼度検索 API
GET の⽂字数制限を回避するために、POST メソッドを利⽤する。
POST メソッドを⽤いてリクエストボディに JSON 形式で検索条件を渡す。
パス︓{施設種類 ID}s/search
メソッド︓POST
No.

種類1

検索条件配列パラメータ
key(querys)

内容省略時

検索項⽬を指し⽰すキー

⼊⼒必須

⼊れ⼦の項⽬はドットで繋いで表現する

2value3op

検索する値

⼊⼒必須

⽐較⽅法。1:'＝ʼ等しい。2:'≠'等しくない。

⼊⼒必須3:'<'検索値より⼩さい。4:'>'検索値より⼤きい。5:'≦'検索値以下。6:'≧'検索値以上。7:
検索値を含む
4

並び順配列

Key

(sortOrder)

検索項⽬を指し⽰すキー

結果は不定

⼊れ⼦の項⽬はドットで繋いで表現する

6order

ソート⽅向。0:昇順。1:降順

0:昇順

7offset検索結果の参照開始位置を指定

08limit

⼀度に参照する施設データの件数を指定

100 件

パラメータ⼊⼒例）橋⻑が 10m 以上 20m 未満の橋梁データの参照をリクエスト{"querys": [{"key": "syogen.kyouchou","value": "10","op": "6"},{11

"key": "syogen.kyouchou","value": "3","op": "6"}],"sortOrder": [{"key": "string","order": "0"}],"offset": 0,"limit": 0}12

3.6.2. 付属ファイル（物理ファイル）の取得 API のパラメータ(1) 第 77 条点検報告書様式ファイル取得 API
指定した施設 ID・点検年度が合致する第７７条点検報告書ファイルを取得する。
パス: {施設種類 ID}/report77/{施設 ID}/{年度}
メソッド︓GET(2) 付属ファイルリスト取得 API
検索条件にマッチする施設データに紐づく付属ファイル(画像、PDF 等)の、ファイル ID 等のファイルリスト(情報)を参照する。
検索条件のパラメータの形式は、施設データ参照 API のものと同⼀である。
パス︓{施設種類 ID}/otherFileList?{検索条件}
メソッド︓GET例) 施設 ID35.1234,130.12345 の橋梁に紐づくファイルリストを取得する
GET https://www.example.go.jp/xROAD/api/v1/bridge/otherFileList?shisetsu=35.1234,130.12345

レスポンスには、ダウンロードに必要な情報が、ダウンロードするファイルの個数分だけ配列の形で返ってくる。
No.

パラメータ

内容

1

file_id

ファイルを特定するための ID

2

file_name

ファイル名

3

shisetsu_id

施設 ID

4

shisetsu_meisyou

施設名称

レスポンス例。resultSet などは省略して表記{
result: {[{file_id: 7653232,
file_name: “◯◯橋 全景.jpg”,
shisetsu_id: “35.12345,130.12345”,
shisetsu_meisyou: “◯◯橋”},{
file_id: 7653233,
file_name: “◯◯橋 主桁 1.jpg”,
shisetsu_id: “35.12345,130.12345”,
shisetsu_meisyou: “◯◯橋”
}
],
}

13

}

ファイルリストに記載されたファイル ID を、次項(3)の付属ファイル取得 API にパラメータとして指定して呼び出すことで、ファイルをダウンロードできる。

(3) 付属ファイル取得 API
前項のその他付属ファイルリスト取得 API を利⽤して取得したファイル ID に合致するファイルを取得する。
パス: /{施設種類 ID}/otherFile/{ファイル ID}
メソッド︓GET
例) ファイル ID7654321 のファイルをダウンロードする
GET /bridge/otherFile/35.2134,139.112/7654321

14

パラメータの定義における留意事項
施設項⽬の定義をもとにして、API のパラメータを設定するにあたり、できるだけ表記のゆれをなくして使いやすくするために、以下の基準でパラメータの定義を⾏うものとする。
3.7.1. パラメータ構造
・項⽬のグループごとにまとめて⼊れ⼦にし、ツリー状の構造とする・JSON で表現できるデータ構造とする・パラメータ名を表記する場合は、⼊れ⼦の親から⼦へ順に「.」(ドット)で繋いで表記とする。
3.7.2. パラメータ名
・半⾓英数字で表記し、単語の接続はスネークケースとする・項⽬名をローマ字で表記する。ただし元がカタカナの場合は英語表記とする
例) 定義ファイル → teigi_file
・項⽬名が冗⻑になる場合は、項⽬名として使える適度な⻑さに短縮する
3.7.3. 選択肢
・複数の中から⼀つを選択する項⽬は、選択肢の内容を直接書き込むのではなく、コード表を作成してコードを⼊⼒する。
例) ⾼速⾃動⾞国道・都道府県道・⼀般国道↓
1:⾼速⾃動⾞国道・2:都道府県道・3:⼀般国道
・「◯△□」などの記号や「有り・無し」などで表現されていた部分もコード表記に統⼀する。
例) 有り・無し → 1・0
3.7.4. 複数年データ
・2018,2019...といった年度毎に 1 列割り当てられているデータは、配列として表現する。
3.7.5. ⽇付表記の統⼀・年データは⻄暦とする。フォーマットは YYYY例) 2021・年⽉フォーマットは YYYYMM
例) 202109
・年⽉⽇フォーマットは YYYYMMDD
例) 20210901

15利⽤制限
本公開⽤ API は、以下の 3 種類の参照⽤アプリによる利⽤を想定した API としている。
・参照⽤アプリ(無償)・参照⽤アプリ(有償)・参照⽤アプリ(⾮公開)
上記の 3 種類のうち、参照⽤アプリ(有償)、参照⽤アプリ(⾮公開)において、本 API を利⽤する場合は、それぞれの利⽤が承認された利⽤者にのみ利⽤を許諾する。
利⽤申請
本公開⽤ API は、以下の 3 種類の参照⽤アプリによる利⽤を想定した API としている。
・参照⽤アプリ(無償)・参照⽤アプリ(有償)・参照⽤アプリ(⾮公開)
上記の 3 種類のうち、参照⽤アプリ(有償)、参照⽤アプリ(⾮公開)については、本 API を利⽤するにあたり、規定の利⽤申請により、API の利⽤⼿続きを⾏うものとする。
認証機能
本公開⽤ API は、以下の 3 種類の参照⽤アプリによる利⽤を想定した API としている。
・参照⽤アプリ(無償)・参照⽤アプリ(有償)・参照⽤アプリ(⾮公開)
上記の 3 種類のうち、参照⽤アプリ(有償)、参照⽤アプリ(⾮公開)にて扱うデータの取り扱いを鑑み、API キー⽅式による認証機能を具備した API の実装とする。
3.10.1. API キー⽅式
API を利⽤するアプリごとに API キーを発⾏し、API アクセス時にその API キーを HTTP ヘッダに記述することによって、発⾏対象のアプリからのアクセスであることを認証する。
発⾏対象以外のアプリからのアクセスを防ぐため、発⾏時に登録したドメイン名や IP アドレスからのアクセス以外は拒否する。
•API キー記述ヘッダ
API-key•API キーフォーマット
半⾓英数字 40 ⽂字
利⽤規約
別途の利⽤規約を参照

16

4. ⽤語集
⽤語１︓N

フリガナ
イチタイタ

定義
1 対多。⼀つの情報に対して複数の情報が対応づいた関係外部のアプリケーションやプログラムからのリクエスト(要求)に対し、

API

エーピーアイ

⼀定の情報を提供するためのサービス。
Application Programming Interface の略

API キー⽅式

GET

エーピーアイキーホウ
シキ
ゲット

アカウント情報などはなくアプリケーションを識別する暗号化された⽂字列を API 利⽤者側が、API 利⽤者時のリクエスト内に含めて送る認証⽅式。
HTTP リクエストメソッドの⼀つで、リソースの取得・参照を⾏うという命令

HTTP ステータスコー エイチティーティーピー

HTTP プロトコルに従った Web サーバからのレスポンスにおいて、そドの通信結果を表す 3 桁のコード

HTTP プロトコル

HTTP ヘッダ

HTTP リクエスト

ステータスコード
エイチティーティーピー
プロトコル

インターネット上で、Web クライアントからリクエストを送り、それを受けて Web サーバからレスポンスを返すことで、データの送受信を⾏う規約

エイチティーティーピー

Web コンテンツの伝送に⽤いられる HTTP で、メッセージの前半にヘッダある制御情報を記した領域のこと

エイチティーティーピー
リクエスト

⼀⽅から他⽅へ送信される、何らかの要求、あるいは、メッセージのこと。本書の場合、API を呼び出す⾏為とそのために必要なデータのことを表す

HTTP リクエストボデ

エイチティーティーピー

HTTP リクエストを構成する 3 つの部品のひとつで、送信内容のィ

リクエストボディ「本⽂」にあたる部分

HTTP リクエストメソ

エイチティーティーピー

HTTP プロトコルで定義された、リソースに対する振る舞いを定義しッド

リクエストメソッド

た命令。GET・POST など数種類が定義されている

エイチティーティーピー

リクエストを受けた対象(サーバ)が処理の結果をリクエスト元に返すレスポンスこと。あるいば返すデータを指す

HTTP レスポンス
ITEF

アイティーイーエフ

JSON

ジェイソン

multipart/form-

マルチパート/フォーム

data

データPOST

ポスト

インターネット技術特別調査委員会。インターネットに関する標準化団体
異なるプログラミング⾔語間でデータをやりとりするための、共通のデータ記述形式の⼀つ。RFC8259 にて定義
リクエストで複数のフォームデータ(マルチパート)を送るための形式。
複数の異なる種類のデータを格納する⽅式。主にファイルアップロー
ドで利⽤される。
HTTP リクエストメソッドの⼀つで、リソースの作成を⾏うという命令

17

⽤語フリガナ

定義
Web システムを外部から利⽤するためのプログラムの呼び出し規REST API

レストエーピーアイ

約（API）の種類の⼀つで、「REST」（レスト）と呼ばれる設計原則に従って策定されたもの

RFC

TLS(SSL)UCSURI エンコード

アールエフシーティーエルエス/エスエスエル
ユーシーエスIETF による技術仕様の保存、公開形式。インターネット上の通信を始めとする技術の仕様の標準としてよく使われる
インターネット上におけるウェブブラウザとウェブサーバ間でのデータの通信を暗号化し、送受信させる仕組み。現在は SSL の後継のTLS が⽤いられるが、慣習として SSL と呼ばれることが多い
符号化⽂字集合や⽂字符号化⽅式などを定めた、⽂字コードの国際標準のひとつで、業界規格の Unicode と概ね互換である

ユーアールアイエンコ

⽂字列を URL に含める場合に、RFC3986 に定められた利⽤可ード

能⽂字以外を変換して問題ない URL にすること
⽂字コードの国際的な業界標準の⼀つで、世界中の様々な⾔語Unicodeユニコードの⽂字を収録して通し番号を割り当て、同じコード体系のもとで使⽤できるようにしたもの

URI

ユーアールアイ

Uniform Resource Identifier の略称。インターネット上で、リソースの場所などを表現する識別⼦
Unicode/UCS で定義された⽂字集合を表現することができる⽂字コード（符号化⽅式）の⼀つ。⼀⽂字を 1〜6 バイトの可変

UTF-8ユーティーエフエイト

⻑で表現するもので、様々な⾔語の⽂字を扱える⽂字コードとしては世界的に最も普及している。正式名称は、ISO/IEC 10646
では “UCS Transformation Format 8”、Unicode では“Unicode Transformation Format-8” という。

エンドポイント

エンドポイント

クエリパラメータ

クエリパラメータ

ネットワークに接続された端末のアドレス。本 API におけるエンドポ
イントは、API に アクセスするための URI を指す
API 利⽤時にサーバへ送る URI のうち、'?'以降の検索条件を表す部分
プログラミングなどで英語の複合語やフレーズ（句）、⽂を⼀語にスネークケーススネークケース繋げて表記する際に、単語間のスペース（空⽩⽂字）をアンダースコア（_）に置き換える⽅式。

スレッド

プログラムの処理の実⾏単位。通常、分岐やループがあっても、プロスレッド

グラム全体は 1 つの流れになっている。

データフォーマット

データフォーマット

複合的なデータの記述⽅法を定めたもの。テータ形式

バイナリ

バイナリ

パラメータ

パラメータ

プログラムの動作を決定するために指定する数値や⽂字列

プログラム

プログラム

コンピュータに対する命令（処理）を記述したもの

コンピュータが直接的に処理するために２進数で表現されるデータ（バイナリデータ）のことを指す

18

⽤語
プロパティ

フリガナ
プロパティ

定義
ソフトウェアが取り扱う対象の持つ設定や状態、属性などの情報を指す事が多い
データを⼩さく分割した単位及びそのアクセス先をページと呼ぶ。全ページネーション

ページネーション

データではなく特定のデータを要求する場合、欲しいデータ（ページ）を指定することとなる

リソース名(本 API)

リソースメイ

本 API においては、API によって取得するデータの種類を表す名前のことを指す

19



更新履歴

Ver.

更新年⽉⽇

内容

1.0

2022.7.12

新規作成

備考20