Mapbox API
Mapbox Web Service APIを使用すると、Mapboxのツールとサービスにプログラム的にアクセスできる。これらのAPIを使用することで、アカウント関連の情報の取得やリソースのアップロードおよび変更やコアのMapboxツールの使用などができる。
Mapbox APIは、マップ、ナビゲーション、検索、およびアカウントっていう4つサービスに分かれる。サービスごとに本ドキュメントに記載されている独自の概要ページがある。これらの各概要ページは、サービスを構成する個々のAPIに分かれる。APIごとのドキュメンテイションがエンドポイントによって構成されている。エンドポイントは、1つのアクションを実行するAPIを備えた特定のメソッドであり、特定のURLに配置される。
本ガイドラインでは、マップサービスについて言及する。
データセット
Mapbox Datasets APIはデータセットからの機能を読み取り、作成、更新、削除をサポートする。
データセットオブジェクト
データセットオブジェクトが特定のデータセットに関連する情報を含む。 データセットオブジェクトごとに下記のプロパティが含まれる：
| プロパティ | 説明 |
|---|---|
| owner | データセット所有者のユーザー名 |
| id | 既存のデータセットのID |
| created | データセットが作成された日時を示すタイムスタンプ |
| modified | データセットが最後に変更された日時を示すタイムスタンプ |
| bounds | [西、南、東、北]の形式であって、データセット内の機能範囲 |
| features | データセット内の機能の数 |
| size | データセットのサイズ（バイト単位） |
| name (任意) | データセット名 |
| description (任意) | データセットの説明 |
データセットオブジェクトの例
1. {
2. "owner": "{username}",
3. "id": "{dataset_id}",
4. "created": "{timestamp}",
5. "modified": "{timestamp}",
6. "bounds": [-10, -10, 10, 10],
7. "features": 100,
8. "size": 409600,
9. "name": "{name}",
10. "description": "{description}"
11. }
データセット一覧
特定のアカウントに属するデータセットの一覧。
| 必須の引数 | 説明 |
|---|---|
| username | データセットを一覧表示するアカウントのユーザー名 |
下記の任意の引数を使用して、このエンドポイントからの結果をさらに絞り込むことができる。
| 任意の引数 | 説明 |
|---|---|
| limit | 返されるデータセットの最大数 |
| start | 一覧開始するデータセットのID。データセットIDがレスポンスのリンクヘッダにある。 詳細はPaginationセクションを参照してください。 |
リクエスト例：データセット一覧
1. $ curl "https://api.mapbox.com/datasets/v1/username?access_token=sk.ACCESS_TOKEN
レスポンス：データセット一覧
このエンドポイントへのリクエストの応答はデータセット一覧である。
レスポンスの例：データセット一覧
1. [
2. {
3. "owner": "{username}",
4. "id": "{dataset_id}",
5. "created": "{timestamp}",
6. "modified": "{timestamp}",
7. "bounds": [-10, -10, 10, 10],
8. "features": 100,
9. "size": 409600,
10. "name": "{name}",
11. "description": "{description}"
12. },
13. {
14. "owner": "{username}",
15. "id": "{dataset_id}",
16. "created": "{timestamp}",
17. "modified": "{timestamp}",
18. "bounds": [-10, -10, 10, 10],
19. "features": 100,
20. "size": 409600,
21. "name": "{name}",
22. "description": "{description}"
23. }
24. ]
データセットの作成
新しく空白のデータセットを作成する。
| 必須の引数 | 説明 |
|---|---|
| username | 新しいデータセットが属するアカウントのユーザー名 |
リクエストの例：データセットの作成
1. $ curl -X POST "https://api.mapbox.com/datasets/v1/{user_account}?access_token=sk.ACCESS_TOKEN
2. This endpoint requires a token with datasets:write scope.
3. " \
4. -d @request.json \
5. --header "Content-Type:application/json
リクエスト本体の例：データセットの作成
1. {
2. "name": "foo",
3. "description": "bar"
4. }
レスポンス：データセットの作成
このエンドポイントへの成功リクエストの応答は新しく空白のデータセットである。
レスポンスの例：データセットの作成
1. {
2. "owner": "{username}",
3. "id": "{dataset_id}",
4. "created": "{timestamp}",
5. "modified": "{timestamp}",
6. "bounds": [-10, -10, 10, 10],
7. "features": 100,
8. "size": 409600,
9. "name": "foo",
10. "description": "bar"
11. }
データセットの取得
単一の既存のデータセットに関する情報を取得する。
| 必須の引数 | 説明 |
|---|---|
| username | データセットが属するアカウントのユーザー名 |
| dataset_id | 取得するデータセットのID |
リクエストの例：データセットの取得
1. $ curl "https://api.mapbox.com/datasets/v1/{user_account}/{dataset_id}?access_token=sk.ACCESS_TOKEN
レスポンス：データセットの取得
このエンドポイントへの成功リクエストの応答はリクエストしたデータセットである。
レスポンスの例：データセットの取得
1. {
2. "owner": "{username}",
3. "id": "{dataset_id}",
4. "created": "{timestamp}",
5. "modified": "{timestamp}",
6. "bounds": [-10, -10, 10, 10],
7. "features": 100,
8. "size": 409600,
9. "name": "{name}",
10. "description": "{description}"
11. }
データセットの更新
特定のデータセットのプロパティを更新する。 リクエスト本体は有効なJSONである必要がある。 本エンドポイントは、データセットオブジェクトの名前と説明を変更するのに使用される。 データセットに機能を追加する、または既存のデータセット機能を編集するには、機能挿入・更新のエンドポイントを使用する。
| 必須の引数 | 説明 |
|---|---|
| username | データセットが属するアカウントのユーザー名 |
| dataset_id | 更新されるデータセットのID |
リクエストの例：データセットの更新
1. $ curl -X PATCH "https://api.mapbox.com/datasets/v1/{user_account} /{dataset_id}?access_token=sk.ACCESS_TOKEN
リクエスト本体の例：データセットの更新
1. {
2. "name": "foo",
3. "description": "bar"
4. }
レスポンス：データセットの更新
このエンドポイントへの成功リクエストの応答は更新されたデータセットである。
レスポンスの例：データセットの更新
1. {
2. "owner": "{username}",
3. "id": "{dataset_id}",
4. "created": "{timestamp}",
5. "modified": "{timestamp}",
6. "bounds": [-10, -10, 10, 10],
7. "features": 100,
8. "size": 409600,
9. "name": "foo",
10. "description": "bar"
11. }
データセットの削除
特定のデータセットを削除する。データセットに含まれる機能もすべて削除される。
| 必須の引数 | 説明 |
|---|---|
| username | データセットが属するアカウントのユーザー名 |
| dataset_id | 削除されるデータセットのID |
リクエストの例：データセットの削除
1. $ curl -X DELETE "https://api.mapbox.com/datasets/v1/{user_account} /{dataset_id}?access_token=sk.ACCESS_TOKEN
レスポンス：データセットの削除
1. HTTP 204
備考：データセットに関する詳細の情報はhttps://docs.mapbox.com/api/maps/#datasets のリンクを参照してください。
タイルセット
Mapbox Tilesets APIはラスターおよびベクタータイルセットのメタデータを読み込むのをサポートする。ベクタタイルをリクエストするには、Vector Tiles API を使用して、ラスタータイルをリクエストするには、Raster Tiles API を使用する。
