From 69b49c4e22e88bb00651ec173909255fbac040fb Mon Sep 17 00:00:00 2001 From: Varun Date: Tue, 25 Oct 2016 17:03:15 -0400 Subject: [PATCH] Added documentation for getting mapzen map credentials and api keys PS2: [LB] Reviewed PS3: [VT/Mike] Updated for the review comment Change-Id: Ibc5be5dc6c1bba24127d7a3b781f53cff2b43335 --- org.tizen.guides/html/index.htm | 1 + .../html/native/location_sensors/maps_n.htm | 6 +- .../location_sensors/mapzen_credentials_n.htm | 163 +++++++++++++++++++++ org.tizen.guides/index.xml | 1 + 4 files changed, 169 insertions(+), 2 deletions(-) create mode 100644 org.tizen.guides/html/native/location_sensors/mapzen_credentials_n.htm diff --git a/org.tizen.guides/html/index.htm b/org.tizen.guides/html/index.htm index 09c9bb5..0ee9d22 100644 --- a/org.tizen.guides/html/index.htm +++ b/org.tizen.guides/html/index.htm @@ -393,6 +393,7 @@
  • Maps and Maps Service
  • Device Sensors
    • diff --git a/org.tizen.guides/html/native/location_sensors/maps_n.htm b/org.tizen.guides/html/native/location_sensors/maps_n.htm index 4ca40b7..33ac10f 100644 --- a/org.tizen.guides/html/native/location_sensors/maps_n.htm +++ b/org.tizen.guides/html/native/location_sensors/maps_n.htm @@ -86,10 +86,12 @@

    Before you start, remember to prepare your application to use the maps service functionality.

    -

    The following map provider is supported:

    +

    The following map providers are supported:

    diff --git a/org.tizen.guides/html/native/location_sensors/mapzen_credentials_n.htm b/org.tizen.guides/html/native/location_sensors/mapzen_credentials_n.htm new file mode 100644 index 0000000..ed7bfa4 --- /dev/null +++ b/org.tizen.guides/html/native/location_sensors/mapzen_credentials_n.htm @@ -0,0 +1,163 @@ + + + + + + + + + + + + +Getting A Mapzen API Key + + + +
    +
    +

    Mobile native

    +
    +
    +
    +

    Dependencies

    +
      +
    • Tizen 3.0 and Higher for Mobile
      • +
    +

    Content

    + +

    Related Info

    + +
    +
    +
    + +
    + +

    Getting A Mapzen API Key

    + +

    Mapzen products help you put a map anywhere, search and route the planet, and try a world of open data. They are built from open-source tools that are packaged into a Web service and hosted on the Mapzen servers. If you want to use Mapzen services, you must create a Mapzen developer account and a valid API key, and keep your requests to the service within certain rate limits.

    + +
    + + + + + + + + +
    Note
    Mapzen products are available for any use, including commercial purposes. You must follow the attribution requirements for the data source, and also provide acknowledgment to Mapzen if you are using these Web services.
    + +

    Mapzen developer account authentication is made through GitHub, which is a Web site that enables people to collaborate on a project. You need a GitHub account to create a Mapzen developer account, as there is currently no other form of authentication.

    + +

    To create the Mapzen API key:

    + +
      +
    1. If you do not have a GitHub account, create it. +

      You can create any kind of account, including personal.

      2. +
    2. Go to https://mapzen.com/developers. +

      This is where you can create, delete, and manage your API keys.

      3. +
    3. Sign in with your GitHub account. +

      If you are signing in for the first time, you must agree to the terms.

      4. +
    4. Create a new Mapzen key in the dashboard. +

      The API key is a code that uniquely identifies your developer account without providing a password.

      5. +
    5. Optionally, give the key a name so you can remember the purpose of the project.
      6. +
    + +

    To use the Mapzen API key in your application, set it with the maps_service_set_provider_key() function:

    + +
    +maps_service_h maps = NULL;
+int error = maps_service_create("MAPZEN", &maps);
+error = maps_service_set_provider_key(maps, "mapzen-xxxxxx")
+
    + +

    API Rate Limits

    + +

    Mapzen offers a free tier for each service, subject to the rate limits listed below. Mapzen-hosted services are shared resources, so there are limitations to prevent individual users from degrading system performance for everyone. 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.

    + +

    All the projects used to build the Mapzen-hosted services are open source. If you want to try Mapzen products, start with the hosted services to see if they fit your work flow needs. If you later decide that you need additional customizations or higher capacity, consider installing the open-source code used to build Mapzen services on your own servers.

    + +

    If you find a problem, need higher limits, or have enhancement suggestions for Mapzen products, contact hello@mapzen.com..

    + +

    The service limitations when using a Mapzen API key:

    + + + +

    API Usage Check

    + +

    To check your usage for a specific API key:

    + +
      +
    1. Sign in to your developer account.
      2. +
    2. Click the statistics button for the API key whose usage you want to review.
      3. +
    3. View a graph of your recent usage for a certain period of time, such as the past day or month.
      4. +
    + +

    If you exceed rate limits, you can notice it in the HTTP status codes you receive in the header for the server's response to your queries. The typical errors for exceeded limits are "403 Forbidden" and "429 Too Many Requests".

    + +

    All queries do not count towards your rate limit. Mapzen uses server caching to deliver commonly requested content as quickly as possible. Queries served from the cache are not included in the rate limit count. For example, queries can be served from the cache when you browse a map with vector tiles in a popular extent or repeatedly perform an identical geocoding search.

    + + + + + + + + + +Go to top + + + + + + + diff --git a/org.tizen.guides/index.xml b/org.tizen.guides/index.xml index 2ef68b7..d0f5457 100644 --- a/org.tizen.guides/index.xml +++ b/org.tizen.guides/index.xml @@ -297,6 +297,7 @@ + -- 2.7.4