From 2bb03225cbd223fdc6d3e3f4a74a0ea430a1d064 Mon Sep 17 00:00:00 2001 From: csobier Date: Mon, 4 Jul 2016 17:30:16 -0400 Subject: [PATCH] updated all api examples with rebranded account url- confirmed by luis --- docs/anonymous_maps.md | 20 ++++++++++---------- docs/named_maps.md | 24 ++++++++++++------------ docs/quickstart.md | 10 +++++----- 3 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/anonymous_maps.md b/docs/anonymous_maps.md index ad315195..5772f5b5 100644 --- a/docs/anonymous_maps.md +++ b/docs/anonymous_maps.md @@ -36,7 +36,7 @@ The response includes: Attributes | Description --- | --- -layergroupid | The ID for that map, used to compose the URL for the tiles. The final URL is: `https://{username}.cartodb.com/api/v1/map/{layergroupid}/{z}/{x}/{y}.png` +layergroupid | The ID for that map, used to compose the URL for the tiles. The final URL is: `https://{username}.carto.com/api/v1/map/{layergroupid}/{z}/{x}/{y}.png` updated_at | The ISO date of the last time the data involved in the query was updated. metadata | Includes information about the layers. cdn_url | URLs to fetch the data using the best CDN for your zone. @@ -46,7 +46,7 @@ cdn_url | URLs to fetch the data using the best CDN for your zone. #### Call ```bash -curl 'https://{username}.cartodb.com/api/v1/map' -H 'Content-Type: application/json' -d @mapconfig.json +curl 'https://{username}.carto.com/api/v1/map' -H 'Content-Type: application/json' -d @mapconfig.json ``` #### Response @@ -79,7 +79,7 @@ When you have a layergroup, there are several resources for retrieving layergoup These tiles will get just the Mapnik layers. To get individual layers, see the following section. ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/{z}/{x}/{y}.png +https://{username}.carto.com/api/v1/map/{layergroupid}/{z}/{x}/{y}.png ``` #### Individual layers @@ -89,7 +89,7 @@ The MapConfig specification holds the layers definition in a 0-based index. Laye Individual layers can be accessed using that 0-based index. For UTF grid tiles: ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/{layer}/{z}/{x}/{y}.grid.json +https://{username}.carto.com/api/v1/map/{layergroupid}/{layer}/{z}/{x}/{y}.grid.json ``` In this case, `layer` as 0 returns the UTF grid tiles/attributes for layer 0, the only layer in the example MapConfig. @@ -97,13 +97,13 @@ In this case, `layer` as 0 returns the UTF grid tiles/attributes for layer 0, th If the MapConfig had a Torque layer at index 1 it could be possible to request it with: ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/1/{z}/{x}/{y}.torque.json +https://{username}.carto.com/api/v1/map/{layergroupid}/1/{z}/{x}/{y}.torque.json ``` #### Attributes defined in `attributes` section ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/{layer}/attributes/{feature_id} +https://{username}.carto.com/api/v1/map/{layergroupid}/{layer}/attributes/{feature_id} ``` Which returns JSON with the attributes defined, like: @@ -115,7 +115,7 @@ Which returns JSON with the attributes defined, like: #### Blending and layer selection ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/{layer_filter}/{z}/{x}/{y}.png +https://{username}.carto.com/api/v1/map/{layergroupid}/{layer_filter}/{z}/{x}/{y}.png ``` Note: currently format is limited to `png`. @@ -127,7 +127,7 @@ Note: currently format is limited to `png`. Using `all` as `layer_filter` will blend all layers in the layergroup ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/all/{z}/{x}/{y}.png +https://{username}.carto.com/api/v1/map/{layergroupid}/all/{z}/{x}/{y}.png ``` - Filter by layer index @@ -135,7 +135,7 @@ https://{username}.cartodb.com/api/v1/map/{layergroupid}/all/{z}/{x}/{y}.png A list of comma separated layer indexes can be used to just render a subset of layers. For example `0,3,4` will filter and blend layers with indexes 0, 3, and 4. ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/0,3,4/{z}/{x}/{y}.png +https://{username}.carto.com/api/v1/map/{layergroupid}/0,3,4/{z}/{x}/{y}.png ``` Some notes about filtering: @@ -172,7 +172,7 @@ callback | JSON callback name. #### Call ```bash -curl "https://{username}.cartodb.com/api/v1/map?callback=callback&config=%7B%22version%22%3A%221.0.1%22%2C%22layers%22%3A%5B%7B%22type%22%3A%22cartodb%22%2C%22options%22%3A%7B%22sql%22%3A%22select+%2A+from+european_countries_e%22%2C%22cartocss%22%3A%22%23european_countries_e%7B+polygon-fill%3A+%23FF6600%3B+%7D%22%2C%22cartocss_version%22%3A%222.3.0%22%2C%22interactivity%22%3A%5B%22cartodb_id%22%5D%7D%7D%5D%7D" +curl "https://{username}.carto.com/api/v1/map?callback=callback&config=%7B%22version%22%3A%221.0.1%22%2C%22layers%22%3A%5B%7B%22type%22%3A%22cartodb%22%2C%22options%22%3A%7B%22sql%22%3A%22select+%2A+from+european_countries_e%22%2C%22cartocss%22%3A%22%23european_countries_e%7B+polygon-fill%3A+%23FF6600%3B+%7D%22%2C%22cartocss_version%22%3A%222.3.0%22%2C%22interactivity%22%3A%5B%22cartodb_id%22%5D%7D%7D%5D%7D" ``` #### Response diff --git a/docs/named_maps.md b/docs/named_maps.md index 552785eb..1ba026a9 100644 --- a/docs/named_maps.md +++ b/docs/named_maps.md @@ -155,7 +155,7 @@ This is the call for creating the Named Map. It is sending the template.json fil curl -X POST \ -H 'Content-Type: application/json' \ -d @template.json \ - 'https://{username}.cartodb.com/api/v1/map/named?api_key={api_key}' + 'https://{username}.carto.com/api/v1/map/named?api_key={api_key}' ``` #### Response @@ -209,7 +209,7 @@ Valid auth token will be needed, if required by the template. curl -X POST \ -H 'Content-Type: application/json' \ -d @params.json \ - 'https://{username}.cartodb.com/api/v1/map/named/{template_name}?auth_token={auth_token}' + 'https://{username}.carto.com/api/v1/map/named/{template_name}?auth_token={auth_token}' ``` #### Response @@ -261,7 +261,7 @@ Updating a Named Map removes all the Named Map instances, so they need to be ini curl -X PUT \ -H 'Content-Type: application/json' \ -d @template.json \ - 'https://{username}.cartodb.com/api/v1/map/named/{template_name}?api_key={api_key}' + 'https://{username}.carto.com/api/v1/map/named/{template_name}?api_key={api_key}' ``` #### Response @@ -303,7 +303,7 @@ api_key | is required #### Call ```bash -curl -X DELETE 'https://{username}.cartodb.com/api/v1/map/named/{template_name}?api_key={api_key}' +curl -X DELETE 'https://{username}.carto.com/api/v1/map/named/{template_name}?api_key={api_key}' ``` #### Response @@ -337,7 +337,7 @@ api_key | is required #### Call ```bash -curl -X GET 'https://{username}.cartodb.com/api/v1/map/named?api_key={api_key}' +curl -X GET 'https://{username}.carto.com/api/v1/map/named?api_key={api_key}' ``` #### Response @@ -377,7 +377,7 @@ api_key | is required #### Call ```bash -curl -X GET 'https://{username}.cartodb.com/api/v1/map/named/{template_name}?api_key={api_key}' +curl -X GET 'https://{username}.carto.com/api/v1/map/named/{template_name}?api_key={api_key}' ``` #### Response @@ -418,7 +418,7 @@ callback | JSON callback name #### Call ```bash -curl 'https://{username}.cartodb.com/api/v1/map/named/{template_name}/jsonp?auth_token={auth_token}&callback=callback&config=template_params_json' +curl 'https://{username}.carto.com/api/v1/map/named/{template_name}/jsonp?auth_token={auth_token}&callback=callback&config=template_params_json' ``` #### Response @@ -543,16 +543,16 @@ To call a template_id in a URL: For example, a complete URL might appear as: -"https://{username}.cartodb.com/api/v1/map/named/{template_id}/{layer}/{z}/{x}/{y}.png" +"https://{username}.carto.com/api/v1/map/named/{template_id}/{layer}/{z}/{x}/{y}.png" The placeholders indicate the following: - [`template_id`](http://docs.carto.com/carto-engine/maps-api/named-maps/#response) is the response of your Named Map. - layers can be a number (referring to the # layer of your map), all layers of your map, or a list of layers. - - To show just the basemap layer, enter the number value `0` in the layer placeholder "https://{username}.cartodb.com/api/v1/map/named/{template_id}/0/{z}/{x}/{y}.png" - - To show the first layer, enter the number value `1` in the layer placeholder "https://{username}.cartodb.com/api/v1/map/named/{template_id}/1/{z}/{x}/{y}.png" - - To show all layers, enter the value `all` for the layer placeholder "https://{username}.cartodb.com/api/v1/map/named/{template_id}/all/{z}/{x}/{y}.png" - - To show a [list of layers](http://docs.carto.com/carto-engine/maps-api/anonymous-maps/#blending-and-layer-selection), enter the comma separated layer value as 0,1,2 in the layer placeholder. For example, to show the basemap and the first layer, "https://{username}.cartodb.com/api/v1/map/named/{template_id}/0,1/{z}/{x}/{y}.png" + - To show just the basemap layer, enter the number value `0` in the layer placeholder "https://{username}.carto.com/api/v1/map/named/{template_id}/0/{z}/{x}/{y}.png" + - To show the first layer, enter the number value `1` in the layer placeholder "https://{username}.carto.com/api/v1/map/named/{template_id}/1/{z}/{x}/{y}.png" + - To show all layers, enter the value `all` for the layer placeholder "https://{username}.carto.com/api/v1/map/named/{template_id}/all/{z}/{x}/{y}.png" + - To show a [list of layers](http://docs.carto.com/carto-engine/maps-api/anonymous-maps/#blending-and-layer-selection), enter the comma separated layer value as 0,1,2 in the layer placeholder. For example, to show the basemap and the first layer, "https://{username}.carto.com/api/v1/map/named/{template_id}/0,1/{z}/{x}/{y}.png" ### Get Mapnik Retina Tiles diff --git a/docs/quickstart.md b/docs/quickstart.md index ba5513da..3a9bf457 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -22,10 +22,10 @@ $.ajax({ type: 'POST', dataType: 'json', contentType: 'application/json', - url: 'https://{username}.cartodb.com/api/v1/map', + url: 'https://{username}.carto.com/api/v1/map', data: JSON.stringify(mapconfig), success: function(data) { - var templateUrl = 'https://{username}.cartodb.com/api/v1/map/' + data.layergroupid + '/{z}/{x}/{y}.png' + var templateUrl = 'https://{username}.carto.com/api/v1/map/' + data.layergroupid + '/{z}/{x}/{y}.png' console.log(templateUrl); } }) @@ -61,7 +61,7 @@ The MapConfig needs to be sent to CARTO's Map API using an authenticated call. H #### Call ```bash -curl 'https://{username}.cartodb.com/api/v1/map/named?api_key={api_key}' -H 'Content-Type: application/json' -d @mapconfig.json +curl 'https://{username}.carto.com/api/v1/map/named?api_key={api_key}' -H 'Content-Type: application/json' -d @mapconfig.json ``` To get the `URL` to fetch the tiles you need to instantiate the map, where `template_id` is the template name from the previous response. @@ -69,7 +69,7 @@ To get the `URL` to fetch the tiles you need to instantiate the map, where `temp #### Call ```bash -curl -X POST 'https://{username}.cartodb.com/api/v1/map/named/{template_id}' -H 'Content-Type: application/json' +curl -X POST 'https://{username}.carto.com/api/v1/map/named/{template_id}' -H 'Content-Type: application/json' ``` The response will return JSON with properties for the `layergroupid`, the timestamp (`last_updated`) of the last data modification and some key/value pairs with `metadata` for the `layers`. @@ -96,5 +96,5 @@ Note: all `layers` in `metadata` will always have a `type` string and a `meta` d You can use the `layergroupid` to instantiate a URL template for accessing tiles on the client. Here we use the `layergroupid` from the example response above in this URL template: ```bash -https://{username}.cartodb.com/api/v1/map/{layergroupid}/{z}/{x}/{y}.png +https://{username}.carto.com/api/v1/map/{layergroupid}/{z}/{x}/{y}.png ```