diff --git a/Makefile b/Makefile index d2b4a90..58a9fff 100644 --- a/Makefile +++ b/Makefile @@ -100,7 +100,7 @@ src-cartography: src-overview: cp -r docs/overview src-overview - + src-guides: cp -r docs/guides src-guides diff --git a/config/overview.yml b/config/overview.yml index 915063b..3e27115 100644 --- a/config/overview.yml +++ b/config/overview.yml @@ -1,12 +1,20 @@ -site_name: Developer overview +site_name: Get started docs_dir: src-overview site_dir: dist-overview pages: - - Overview: index.md + - 'Home': index.md + - 'Account settings': 'account-settings.md' + - 'Billing information': 'billing.md' + - 'API keys': 'api-keys.md' + - 'Rate limits': 'rate-limits.md' + - 'Support': 'support.md' + +# mz:redirects: +# 'overview/#rate-limits': 'overview/rate-limits' extra: - site_subtitle: Get started developing with Mapzen's products + site_subtitle: Get started developing on the Mapzen platform by setting up your account, API keys, and billing information. project_repo_url: https://github.com/mapzen/mapzen-docs-generator - docs_base_url: https://github.com/mapzen/mapzen-docs-generator/tree/master/docs/overview + docs_base_url: https://github.com/mapzen/mapzen-docs-generator/tree/master/docs/overview/ exclude_home_contents_in_toc: false diff --git a/docs/overview/account-settings.md b/docs/overview/account-settings.md new file mode 100644 index 0000000..b07ae0a --- /dev/null +++ b/docs/overview/account-settings.md @@ -0,0 +1,72 @@ +# Update your Mapzen account settings + +_Note: You may not see all billing and account settings options right now while your account is being upgraded. The rate limit and pricing information presented here will be fully effective for all accounts starting June 1, 2017._ + +When you signed in on Mapzen’s website, you can view and modify your account settings. These include changing your email address and password, and updating your credit card and billing information. + +## Sign up for a Mapzen account + +1. Go to https://mapzen.com. +2. Click `Sign Up`. +3. Choose your authentication method. Create your account by entering your e-mail address and password, or if you have a [GitHub](https://github.com) account, you can use it for authentication. GitHub is a website that enables people to collaborate on a project. + +When you create an account, you need to agree to the Mapzen [Terms of Service](https://mapzen.com/terms/). + +In the future when you sign in, use either your email address and password or GitHub account, depending on how you registered originally. If you forgot your password, you can also attempt to reset it. + +To delete your account, you need to [contact Mapzen](mailto:support@mapzen.com). If you are using GitHub, sign into your GitHub account and revoke [Mapzen Platform](https://help.github.com/articles/reviewing-your-authorized-applications-oauth/) as an authorized application. + +## Change your email address or password + +1. Sign in to your Mapzen account. +2. In the top corner of the page, click `Account` and click `Settings`. +3. If you are using an email address to sign in, you can update your email address and password. +4. With GitHub authentication, you can change your email address where you receive communications from Mapzen. Note that this is the address that was part of your GitHub profile when you originally authenticated your Mapzen account. + +## Add your payment method + +To use any of Mapzen’s services above the free limits, you need to add a payment method to your account. + +If you do not have a valid credit card on file and you reach the free limits, your access to that Mapzen service will cease for the remainder of the month. You can continue to use other services up to their individual free limits. + +At the end of each month, Mapzen calculates your usage and bill, and your charges are paid automatically by the credit card on file. + +1. Sign in to your Mapzen account. +2. In the top corner of the page, click `Account` and click `Settings`. +3. In the `Billing` section, `Add Payment Method`. +4. Enter your credit card information. + +If your account has any pending usage charges in a month, you can update it to a different credit card, but are unable to delete your credit card altogether until the balance has cleared. + +## Set monthly spending limits + +You can set limits on your spending each month. This gives you the comfort of knowing that your bill will not exceed the amount you specify. You will only be charged for what you use, which may be less than the limit you set for the month. + +To set a spending limit, you first need to add a payment method to your account. By default, there is no spending limit on your account, which means your usage (and potential bill) is unrestricted. + +Limits can be changed at any time, but cannot be set to an amount lower than the already accrued charges for that month. After you change your limit, the monthly spending limit stays the same month after month into the future. You will be notified by email as you approach your spending limit. + +The spending limit applies across all services. If you reach your spending limit by using only Mapzen Search, for example, you will not be able to use Mapzen Search or any other services beyond the free limits for the remainder of the month. Your account will not accumulate any charges for overages, but no results will be returned for your API requests. This means that your maps may no longer function. + +Rate limits are reset on the first day of every month at 00:00 UTC (Coordinated Universal Time). + +See https://mapzen.com/pricing for more information on current pricing and the limits available with the free plan. + +1. Sign in to your Mapzen account. +2. In the top corner of the page, click `Account` and click `Settings`. +3. Make sure you have a payment method on your account. You will not see additional billing information unless you have a credit card on file. +4. In the `Billing` section, click `Update` under `Monthly spending limit`. +5. Make sure your billing status is `Enabled`. +6. Enter the maximum you want to spend across all Mapzen services. + +As you approach your spending limit, your choices are to increase your spending limits, adjust your usage, or accept that your access to higher rate limits will end. + +## Set your billing status + +When billing is enabled, you have access to Mapzen services at levels above the free limits and are agreeing to pay for your usage, up to your monthly spending limit, if one exists. By default, billing is enabled when you add a payment method to your account. + +To stop billing, set your billing status to disabled in the `Billing` section of your account settings. This has the effect of setting your monthly spending limit to $0 because you are only able to use Mapzen services up to the free limits of each product. If you exhaust the free limits, your maps may no longer function. + +Any charges that were pending before you disabled billing will still be charged to the credit card on file at the end of the current billing cycle. However, no further charges can accrue. The billing status remains as you set it until you change it in the future. + +Anytime you want to start billing again, set your billing status to `Enabled`. diff --git a/docs/overview/api-keys.md b/docs/overview/api-keys.md new file mode 100644 index 0000000..d37268d --- /dev/null +++ b/docs/overview/api-keys.md @@ -0,0 +1,56 @@ +# Create and manage your Mapzen API keys + +When signed in to your Mapzen account, you can access a dashboard that allows you to create, manage, and track the usage of your Mapzen API keys. An API key is a code that uniquely links API usage inside your application with your Mapzen account without needing a password. + +Mapzen's web services have various API endpoints that allow you to access web resources through a URL. You will need to include your API key in the URL you construct to send requests to Mapzen's services. For example, add an `api_key` URL parameter to any request, such as `?api_key=your-mapzen-api-key`. An API key works for any Mapzen service. + +You must include an API key when using Mapzen's services; requests sent without an API key return errors. + +## Create an API key + +1. Go to https://mapzen.com. +2. In the top corner of the page, click `Account` and click `Dashboard`. This is where you can create, delete, and manage your API keys. +3. Create a new key. +4. Optionally, give the key a name so you can remember the purpose of the project. +5. When you are ready to use it, copy the key and paste it into your code. In your query, the API key parameter should take the form of `api_key=your-mapzen-api-key`, substituting your actual API key for `your-mapzen-api-key` part of the example. + +_Note: The free rate limits are applied to your usage across your entire account. Creating multiple keys does not increase these limits._ + +## Choose an API key strategy for your app + +The simplest workflow is for your app to employ a centralized API key for all users. This could mean that you deploy your app with a single key with enough capacity to cover all of your users’ usage. A valid variation is to create and deploy multiple keys if you want to monitor usage and billing for a particular client or function within your app. + +In this model, the API keys in your app are linked to your Mapzen account. This makes you responsible for the costs associated with all of the usage for the keys that are deployed in your app. You can set a spending limit on your account to avoid unexpected charges, although be aware that the app may not function after the spending limit is reached. + +The alternative and more complex API key workflow is for your app to provide an option for users to enter an API key from their own Mapzen accounts. Doing this allows your users to have their own free rate limits, and makes them individually liable for their usage costs. If you implement this method, your app should clearly indicate that a valid Mapzen API key is required. Otherwise, your users will see errors if they fail to include an API key when using Mapzen's services. + +## Protect your API keys + +If you want to keep your API key private, you can consider using a proxy system to hide the key from your users. + +Here is an example of how to do this with [mapzen.js](https://mapzen.com/documentation/mapzen-js/). In your YAML scene file that defines the Tangram map, add a `sources` parameter for the API key. + +``` +sources: + mapzen: + [...] + url_params: + api_key: global.sdk_mapzen_api_key +``` + +Then, in the JavaScript, use your actual key in place of `your-mapzen-api-key` in this code. + +``` +var map = L.Mapzen.map('map', { + tangramOptions: { + scene: { + [...] + global: { + sdk_mapzen_api_key: 'your-mapzen-api-key' + } + } + } +} +``` + +If you believe your API key has been compromised or used without your knowledge, contact [Mapzen](mailto:support@mapzen.com). You can also delete API keys or rotate them periodically in your app. There is not currently a default way to limit an API key for usage only on a particular web domain. diff --git a/docs/overview/billing.md b/docs/overview/billing.md new file mode 100644 index 0000000..d85792d --- /dev/null +++ b/docs/overview/billing.md @@ -0,0 +1,32 @@ +# View your current usage and bill + +_Note: You may not see all billing and account settings options right now while your account is being upgraded. The rate limit and pricing information presented here will be fully effective for all accounts starting June 1, 2017._ + +When you are signed in with your Mapzen account, you can view your current usage and charges due. + +You can think of your Mapzen bill as similar to a home utility bill, where your charges are dependent on how much water or electricity, for example, you consumed in a month. + +Because there are no paid tiers, you pay for each individual API request you make above the free rate limits. Although you may see pricing listed in units of 1,000, requests are not purchased in bundles. For example, $0.05 per 1,000 is intended to be a simpler way of representing that each request is $0.00005. + +Billing is post-paid after the month ends, and there are no prepayment discounts available. There are no minimum fees for maintaining a Mapzen account, even if you have no usage for a while. + +The billing currency is the United States Dollar (USD). Mapzen handles the payment of sales or usage tax that may be required in your area. + +If you need to update your credit card information, you can do that from your [Mapzen account settings](account-settings.md#add-your-payment-method). If you have questions about your bill or are having problems paying it, please contact Mapzen at support@mapzen.com. + +## View your usage + +To check your usage, sign in to your developer account and review your dashboard. + +1. Sign in to your Mapzen account. +2. In the top corner of the page, click `Account` and click `Dashboard`. This page shows your current Mapzen API keys. +3. Click one of your API keys in the list and click `Usage`. The graphs show the number of requests on this key for each product. + +## Request a bill credit for service issues + +_Note: This is only available to users who subscribe to premium support, which includes a service-level agreement._ + +While Mapzen hopes you never experience an outage or downtime in services, you can request a credit in the event that issues occur. See the Mapzen [Terms of Service](https://mapzen.com/terms/) for more information about your rights and requirements, and keep in mind that those terms supersede any documentation content here. + +1. If you are a premium support subscriber and believe that Mapzen has not met the uptime percentage in the developer agreement, record any information about the downtime you can, such as the service name and API, date and time, and estimated outage amount. +2. Within 15 days, send this to [Mapzen support](mailto:hello@mapzen.com) for review. diff --git a/docs/overview/index.md b/docs/overview/index.md index 7614b75..a4ef634 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -1,159 +1,58 @@ -Mapzen's products help you put a map anywhere, search and route the planet, and try a world of open data. These are built from open-source tools that are packaged into a web service and hosted on Mapzen's servers. If you want to use Mapzen's services, you need to create a Mapzen developer account and a valid API key, and keep your requests to the service within certain rate limits. +# Get started developing with Mapzen -## Developer accounts and API keys +Mapzen’s products help you put a map anywhere, search and route the planet, and try a world of open data. -Mapzen developer account authentication is through [GitHub](https://github.com), which is a website that enables people to collaborate on a project. You need to have a GitHub account to create a Mapzen developer account, as there is currently no other form of authentication. +Follow these steps to get started developing on the Mapzen platform. -When signed in to your Mapzen developer account, you see a dashboard where you can create an API key, which is a code that uniquely links API usage inside your application with your account without needing a password. +## 1. Sign up for a Mapzen account -1. If you do not have a GitHub account, create one at https://github.com/join. It can be any kind, including personal. -2. Go to https://mapzen.com/developers. This is where you can create, delete, and manage your API keys. -3. Sign in with your GitHub account. If you have not done this before, you need to agree to the terms first. -4. Create a new Mapzen Key. -5. Optionally, give the key a name so you can remember the purpose of the project. -6. When you are ready to use it, copy the key and paste it into your code. In your query, the API key parameter should take the form of `api_key=mapzen-xxxxxx`. +Your first step is to create a Mapzen developer account. After you sign in, you can modify your account settings, view your Mapzen service usage, and manage your API keys. An account and API keys are required to use Mapzen services, even within the free limits. -Mapzen's web services have various API endpoints that allow you to access web resources through a URL. You will need to include your API key in the URL you construct to send queries to Mapzen's services. For example, add an `api_key` URL parameter to any request, such as `?api_key=mapzen-xxxxxx`. +1. Go to https://mapzen.com. +2. Click `Sign Up`. +3. Choose your authentication method. -## Rate limits -Mapzen offers a free tier of each service, subject to the rate limits listed below. Mapzen's hosted services are shared resources, so there are limitations to prevent individual users from degrading system performance for everyone. +[Learn more about creating a Mapzen account](account-settings.md#sign-up-for-a-mapzen-account) -The services have maximum numbers of queries you can make within a certain period of time, and some have additional limitations to minimize computationally intensive uses. +## 2. Get an API key -All the projects used to build the Mapzen-hosted services are open source. If you want to try Mapzen's products, start with the hosted services to see if they fit your workflow needs. If you later decide that you need additional customizations, you can consider installing on your own servers the open-source code used to build Mapzen's services. +An API key is a code that uniquely links API usage inside your application with your Mapzen account. You must include a Mapzen API key with all your server requests. -You must include an API key when using Mapzen's services; requests sent without an API key return errors. +When signed in to your Mapzen account, you can access a dashboard that allows you to create, manage, and track the usage of your Mapzen API keys. -If you find a problem, need higher limits, or have enhancement suggestions for Mapzen's products, send a note to hello@mapzen.com. +One API key works for any Mapzen service. -#### Check your usage +[Learn how to create and manage your API keys](api-keys.md) -To check your usage, sign in to your developer account. +## 3. Customize your billing settings -1. Sign in at https://mapzen.com/developers. -2. Click the statistics button for the API key you want to review. -3. View a graph of your recent usage for a certain period of time, such as the past day or month. +You can create an API key and use Mapzen's services up to the monthly rate limits for free. If you reach the limits on one Mapzen service, you can continue to use others up to their free limits. Rate limits reset at the beginning of every month. -You also receive [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) in the header for the server's response to your query. +If you need more than the free rate limits, [add a payment method to your account](account-settings.md#add-your-payment-method). Otherwise, if you exhaust the free limits, your maps may no longer function. -If you exceed rate limits, you will typically see errors for 403 Forbidden and 429 Too Many Requests. +You can take control of your bill by [setting a monthly spending limit](account-settings.md#set-monthly-spending-limits). This gives you the comfort of knowing that your bill will not exceed the amount you specify. You can modify your spending limit at any time. -Mapzen uses server caching to deliver commonly requested content as quickly as possible. Queries that are served from a cache do not count toward your rate limits. For example, you might encounter results from the cache when you browse a map with vector tiles in a popular extent or repeatedly perform an identical geocoding search. +Your usage is calculated monthly and any balance due is automatically billed to the credit card in your account. -### Mapping products +[Learn more about tracking your usage and billing](billing.md) -#### Tangram +## 4. Start building -[Tangram](https://mapzen.com/documentation/tangram/), Mapzen's rendering software for web and mobile apps, does not require its own API key. However, if you are using Tangram to draw data from Mapzen's vector tiles service, you need an API key. +If you are new to the Mapzen platform, you might try these tutorials. -#### Mapzen Basemap Styles +- [Get started with mapzen.js](https://mapzen.com/documentation/mapzen-js/get-started/), the Mapzen JavaScript SDK +- [Add Turn-by-Turn routing to a map](https://mapzen.com/documentation/mobility/turn-by-turn/add-routing-to-a-map/) +- [Add the Mapzen Search geocoder to a map](https://mapzen.com/documentation/search/add-search-to-a-map/) +- Get started with [Mapzen Android SDK](https://mapzen.com/documentation/android/getting-started/) and [Mapzen iOS SDK](https://mapzen.com/documentation/ios/getting-started/) -Mapzen's [cartography](https://mapzen.com/documentation/cartography/) requires an API key to enable access to Mapzen vector and terrain tiles data sources. +### Learn about the limits and legal terms -#### Mapzen Vector Tiles +#### Rate limits -[Mapzen Vector Tiles](https://mapzen.com/documentation/vector-tiles/) provides global basemap coverage and has these limits: +Mapzen offers some level of free access to each service, subject to rate limits. The services have maximum numbers of requests you can make per month, and some have additional service limitations to minimize computationally intensive uses. To review the current limits for all Mapzen services, see [Rate limits](rate-limits.md). -- 100 queries per second (about six map views per second) -- 2,000 queries per minute (about 133 views per minute) -- 100,000 queries per day (about 6,600 views per day) +#### Terms of use -When viewing a map, you commonly use about 15 tiles at a time. The number of map views is an attempt to translate the query rate limits into practical expectations in an app. +Mapzen's products are available for any use, including commercial purposes. You need to follow the [attribution requirements](https://mapzen.com/rights/) for the data source, and also provide acknowledgement if you are using Mapzen's web services. -The Mapzen Vector Tiles service is built from the [Tilezen](https://github.com/tilezen) open-source project. - -#### Mapzen Terrain Tiles - -[Mapzen Terrain Tiles](https://mapzen.com/documentation/terrain-tiles/) provides global elevation coverage. This service is 100% cached and there are no rate limits. - -The Mapzen Terrain Tiles service is built from the [Joerd](https://github.com/tilezen/joerd) open-source project. - -### Search and mobility products - -#### Mapzen Search - -[Mapzen Search](https://mapzen.com/documentation/search/) is a geocoding and place-finding service and has these limits: - -- 6 queries per second -- 30,000 queries per day - -The Mapzen Search service is built from the [Pelias](https://github.com/pelias) open-source project. - -#### Mapzen Turn-by-Turn - -[Mapzen Turn-by-Turn](https://mapzen.com/documentation/turn-by-turn/) is a routing and navigation service and has these limits: - -- 2 queries per second -- 50,000 queries per day -- Pedestrian routes have a limit of 50 locations and 250 kilometers. -- Bicycle routes have a limit of 50 locations and 500 kilometers. -- Automobile routes have a limit of 20 locations and 5,000 kilometers. -- Multimodal routes have a limit of 500 kilometers between locations. - -The distance limit is the total straight-line distance (colloquially, as the crow flies) along a path through successive locations. - -#### Mapzen Matrix - -[Mapzen Matrix](https://mapzen.com/documentation/matrix/) provides time and distance calculations between locations and has these limits: - -- 2 queries per second -- 5,000 queries per day -- The maximum number of locations is 50 for any type of matrix. -- The maximum straight-line distance between two locations is 200 kilometers. - -#### Mapzen Optimized Route - -[Mapzen Optimized Route](https://mapzen.com/documentation/optimized/) finds the most efficient route between many locations. The service has these limits: - -- 2 queries per second -- 5,000 queries per day -- The maximum number of locations is 50. -- The maximum straight-line distance between two locations is 200 kilometers. - -#### Mapzen Isochrone - -[Mapzen Isochrone](https://mapzen.com/documentation/mobility/isochrone/api-reference/) provides a computation of areas that are reachable within specified time periods from a location or set of locations. The service has these limits: - -- 2 queries per second -- 5,000 queries per day -- The maximum number of locations is one. For isochrones around multiple locations, you need to make multiple requests. -- The maximum time to compute isochrone contours from the location is 120 minutes. -- The maximum number of isochrone contours in a single request is four. - -The Mapzen Turn-by-Turn, Matrix, Optimized Route, and Isochrone services are built from the [Valhalla](https://github.com/valhalla) open-source project. - -### Data products - -#### Mapzen Elevation - -[Mapzen Elevation](https://mapzen.com/documentation/elevation/) provides the height or elevation at a set of locations and has these limits: - -- 2 queries per second -- 20,000 queries per day - -There are also limitations on the number of sampling points for which you request elevations. - -The Mapzen Elevation lookup service is built from the [Valhalla](https://github.com/valhalla) open-source project. - -#### Who's On First - -Retrieve data about places from the [Who's On Firsts](https://mapzen.com/documentation/wof/) gazetteer. - -- Queries per day: 25,000 -- Queries per minute: 300 -- Queries per second: 6 - -#### Other data products - -Mapzen's other data products do not currently require API keys. These include: - -- Metro Extracts, downloadable snapshots of OpenStreetMap data (Note: you will need to sign in with a developer account to download custom extracts) -- Transitland, the open transit data project - -### Mobile products - -To use Mapzen's Android SDK or any of Mapzen's other products in your mobile apps, you need an API key for the function you are integrating. For example, adding routing to your app requires a Mapzen API key. - -## Terms of use - -Mapzen's products are available for any use, including commercial purposes. You need to follow the [attribution requirements](https://mapzen.com/rights/) for the data source, and also provide acknowledgement to Mapzen if you are using these web services. +See the full [developer terms](https://mapzen.com/terms/) for more information. diff --git a/docs/overview/rate-limits.md b/docs/overview/rate-limits.md new file mode 100644 index 0000000..50ed910 --- /dev/null +++ b/docs/overview/rate-limits.md @@ -0,0 +1,126 @@ +# Rate limits + +_Note: You may not see all billing and account settings options right now while your account is being upgraded. The rate limit and pricing information presented here will be fully effective for all accounts starting June 1, 2017._ + +Mapzen offers some level of free access to each service, subject to rate limits. The services have maximum numbers of requests you can make per month, and some have additional service limitations to minimize computationally intensive uses. + +To use Mapzen’s services above the free limits, you need to [add a payment method to your account](account-settings.md#add-your-payment-method) and enable billing. + +All the projects used to build the Mapzen-hosted services are open source. If you want to try Mapzen’s products, start with the hosted services to see if they fit your workflow needs. If you later decide that you need additional customizations, you can consider installing on your own servers the open-source code used to build Mapzen’s services. + +You must include an API key when using Mapzen’s services; requests sent without an API key return errors. + +## Mapping products + +### Tangram + +[Tangram](https://mapzen.com/documentation/tangram/), Mapzen's rendering software for web and mobile apps, does not require its own API key. However, if you are using Tangram to draw data from Mapzen's vector tiles service, you need an API key. + +### Mapzen Basemap Styles + +Mapzen's [cartography](https://mapzen.com/documentation/cartography/) requires an API key to enable access to Mapzen vector and terrain tiles data sources. + +### Mapzen Vector Tiles + +[Mapzen Vector Tiles](https://mapzen.com/documentation/vector-tiles/) provides global basemap coverage and has these limits: + +- 50,000 free requests per month + +When viewing a map, you commonly use about 15 tile requests at a time. + +The Mapzen Vector Tiles service is built from the [Tilezen](https://github.com/tilezen) open-source project. + +### Mapzen Terrain Tiles + +[Mapzen Terrain Tiles](https://mapzen.com/documentation/terrain-tiles/) provides global elevation coverage and there are no rate limits. + +The Mapzen Terrain Tiles service is built from the [Joerd](https://github.com/tilezen/joerd) open-source project. + +## Search and mobility products + +### Mapzen Search + +[Mapzen Search](https://mapzen.com/documentation/search/) is a geocoding and place-finding service and has these limits: + +- 25,000 free requests per month for forward geocoding, reverse geocoding, and place lookup +- 50,000 free requests per month for autocomplete + +The Mapzen Search service is built from the [Pelias](https://github.com/pelias) open-source project. + +### Mapzen Turn-by-Turn + +[Mapzen Turn-by-Turn](https://mapzen.com/documentation/turn-by-turn/) is a routing and navigation service and has these limits: + +- 5,000 free requests per month +- Pedestrian routes have a limit of 50 locations and 250 kilometers. +- Bicycle routes have a limit of 50 locations and 500 kilometers. +- Automobile routes have a limit of 20 locations and 5,000 kilometers. +- Multimodal routes have a limit of 500 kilometers between locations. + +The distance limit is the total straight-line distance (colloquially, as the crow flies) along a path through successive locations. + +### Mapzen Matrix + +[Mapzen Matrix](https://mapzen.com/documentation/matrix/) provides time and distance calculations between locations and has these limits: + +- 5,000 free requests per day +- The maximum number of locations is 50 for any type of matrix. +- The maximum straight-line distance between two locations is 200 kilometers. + +_Note: This service currently offers only free access with these limits. Mapzen is working on updating this service to allow increased usage._ + +### Mapzen Optimized Route + +[Mapzen Optimized Route](https://mapzen.com/documentation/optimized/) finds the most efficient route between many locations. The service has these limits: + +- 5,000 free requests per day +- The maximum number of locations is 50. +- The maximum straight-line distance between two locations is 200 kilometers. + +_Note: This service currently offers only free access with these limits. Mapzen is working on updating this service to allow increased usage._ + +### Mapzen Isochrone + +[Mapzen Isochrone](https://mapzen.com/documentation/mobility/isochrone/api-reference/) provides a computation of areas that are reachable within specified time periods from a location or set of locations. The service has these limits: + +- 5,000 free requests per day +- The maximum number of locations is one. For isochrones around multiple locations, you need to make multiple requests. +- The maximum time to compute isochrone contours from the location is 120 minutes. +- The maximum number of isochrone contours in a single request is four. + +_Note: This service currently offers only free access with these limits. Mapzen is working on updating this service to allow increased usage._ + +The Mapzen Turn-by-Turn, Matrix, Optimized Route, and Isochrone services are built from the [Valhalla](https://github.com/valhalla) open-source project. + +## Data products + +### Mapzen Elevation + +[Mapzen Elevation](https://mapzen.com/documentation/elevation/) provides the height or elevation at a set of locations and has these limits: + +- 20,000 free requests per day + +There are also limitations on the number of sampling points for which you request elevations. + +_Note: This service currently offers only free access with these limits. Mapzen is working on updating this service to allow increased usage._ + +The Mapzen Elevation lookup service is built from the [Joerd](https://github.com/tilezen/joerd) open-source project. + +### Who's On First + +Retrieve data about places from the [Who's On First](https://mapzen.com/documentation/wof/) gazetteer. + +- 25,000 free requests per day + +_Note: This service currently offers only free access with these limits. Mapzen is working on updating this service to allow increased usage._ + +### Other data products + +Mapzen's other data products do not currently require API keys. These include: + +- [Metro Extracts](https://mapzen.com/data/metro-extracts/), downloadable snapshots of OpenStreetMap data (Note: you will need to sign in with a developer account to download custom extracts) +- [Transitland](https://transit.land/), the open transit data project + +## Mobile products + +To use Mapzen's [Android](https://mapzen.com/documentation/android/) or [iOS](https://mapzen.com/documentation/ios/) SDKs or any of Mapzen's other products in your mobile apps, you need an API key. You are subject to the rate limits for the Mapzen service you are integrating in your app. diff --git a/docs/overview/support.md b/docs/overview/support.md new file mode 100644 index 0000000..492260a --- /dev/null +++ b/docs/overview/support.md @@ -0,0 +1,51 @@ +# Get more help + +Mapzen has many ways for you to get more help, and wants to hear from you. You can send a note about your bill, bugs or unexpected results, enhancement requests for future development, projects you have built with Mapzen, or any other questions you might have. + +All Mapzen users have access to standard email support. Premium support with a service-level agreement is available for an additional monthly fee, and you can subscribe even if you are within the free rate limits of Mapzen’s products. Premium support users receive priority response times, usually within one business day. To sign up for premium support, [contact Mapzen](support@mapzen.com). + +## Read documentation and blog posts + +You can get self-service help at any time from Mapzen's [technical documentation](https://mapzen.com/documentation/) and [blog](https://mapzen.com/blog/). + +Click the `Documentation` link at the top of any page on Mapzen's site to get to the help system. Documentation includes a variety of content, including comprehensive developer API reference, tutorials, glossaries, and conceptual overviews. If you want to help other users by making a correction or addition, each page has a button at the bottom (`Edit this page on GitHub`) that takes you to the source file. + +The Mapzen blog is the home for Mapzen news, including announcements, engineering deep-dives, and product showcases and case studies. The blog posts and other company news are rolled into a monthly email newsletter. Sign up: https://mapzen.com/newsletter-signup/. + +## Contact Mapzen by email + +Mapzen's main technical support email address is support@mapzen.com. Check in about anything you need, such as APIs, workflow guidance, and rate limits. The questions you ask to improve the technical documentation so the answer is easier to find for the next person who has the same problem. + +If you need help with a technical issue, please include any details necessary to investigate your report. This can include concise instructions to reproduce the problem, the behavior you expected compared to what you saw, code samples, and screenshots. + +## Contact Mapzen from within your dashboard + +If you are signed in, you can use a web form to send a question or feedback to Mapzen. Be sure to include your correct email address for a response. + +1. Sign in to your Mapzen account. +2. In the top corner of the page, click `Account` and click `Dashboard`. +3. Click the `Support` button in the bottom corner, fill in the form, and submit it. + +## Connect with the Mapzen developer community + +### Social media + +Mapzen loves hearing from you on social media. Follow [@mapzen](https://twitter.com/mapzen) to be the first to know about Mapzen announcements, and tweet your questions and links to the interesting work you are doing with Mapzen's products. Mapzen also has pages on [Facebook](https://www.facebook.com/gomapzen), [LinkedIn](https://www.linkedin.com/company/mapzen), and other sites. + +### GitHub and community chat + +If you are working with the code for Mapzen's open-source projects, you might be more comfortable communicating with through [GitHub](https://github.com). GitHub is the collaborative version control system Mapzen uses to manage code and documentation. Posting an issue lets engineers and other users know about a bug or software enhancement directly. + +[Gitter](https://gitter.im) is an instant message chat system for GitHub users. Some of Mapzen's development teams have set up chat rooms associated with Mapzen's open-source projects so you can communicate with staff and the community in near real time. + +- [Pelias](https://gitter.im/pelias/pelias) for geographic search and geocoding +- [Tangram](https://gitter.im/tangrams/tangram-chat) for the map-drawing engine +- [Tilezen](https://gitter.im/tilezen/tilezen-chat) for vector tiles and map data + +If you have questions about running your own instance of Mapzen's open-source projects, GitHub and Gitter are your best options. + +Another option for community chat is the #mapzen channel in [The Spatial Community](http://thespatialcommunity.org/), an online chat with thousands of geospatial enthusiasts as members. + +### Events at Mapzen offices + +If you are near a Mapzen office in the New York or San Francisco area, Mapzen occasionally hosts community events. In addition, Mapzen regularly offers office hours, where you can get personalized technical assistance and training and meet other users. Dates and times are usually announced on the [@mapzen](https://twitter.com/mapzen) Twitter account and in the [email newsletter](https://mapzen.com/newsletter-signup/). diff --git a/src-index/index.md b/src-index/index.md index b7f5b7e..5b26767 100644 --- a/src-index/index.md +++ b/src-index/index.md @@ -7,25 +7,33 @@
+ Get started developing on the Mapzen platform by setting up your account, API keys, and billing information. +
+- New to Mapzen? Learn more about rate limits and API keys to start working with our products in minutes. -
++ Set up your development environment with these general guides. +
+- Basemap styles and hundreds of map icons. + Get everything you need to use Mapzen basemaps and icons in your applications.
- Render 2D and 3D maps with fine control over almost every aspect of the map-making process. + Render 2D and 3D maps with fine control over the map-making process.
- Find places and addresses with this geographic search service built on open tools and open data. + Find places and addresses with this geographic search service.