Obtain your API Key

Important

To use the Geocoding API you must have an API key. The API key is a unique identifier that is used to authenticate requests associated with your project for usage and billing purposes.

Obtain your API Key

You must have at least one API key associated with your project.

To get an API key:

1. Visit the Geodir Account Panel (opens new window). If yo don't have an account, please Register (opens new window).
2. The new API key is listed on the page under API keys. (Remember to restrict the API key before using it in production.)

Add the API key to your request

You must include an API key with every Geocoding API request. In the following example, replace YOUR_KEY with your API Key.

https://apis.geodir.co/geocoding/v1/json?address=jr pedro ruiz gallo nro 668&segments=locality_id:150105&key=YOUR_KEY

Restrict the API key

We strongly recommend that you restrict your API key. Restrictions provide added security and help ensure only authorized requests are made with your API key. There are two restrictions. You should set both:

• Application restriction: Limits usage of the API key to either websites (HTTP referrers), web servers (IP addresses), or mobile apps (Android apps or iOS apps). You can select only one restriction from this category. Note: If you need to call web, web service, and/or mobile APIs from the same (client-side) app, create and restrict multiple keys.
• API restriction: Limits usage of the API key to one or more APIs or SDKs. Requests to an API or SDK associated with the API key will be processed. Requests to an API or SDK not associated with the API key will fail. (The API or SDK must be enabled and must support the application restriction.)

To restrict an API key:

1. Go to the Geodir Account Panel (opens new window)
2. Click the project drop-down and select the project that contains the API key you want to secure.
3. Click the menu button and select APIs - Credentials.
4. On the Credentials page, click the name of the API key that you want to secure.
5. On the Restrict and rename API key page, set the restrictions:
   • Application restrictions
     • Select IP addresses (web servers, cron jobs, etc.).
     • Add the server IP addresses.
   • API restrictions
     • Select Restrict key.
     • Click Select APIs and select Geocoding API. (If the Geocoding API is not listed, you need to enable it.)
   • Click SAVE.

Troubleshooting authentication issues

If your request is malformed or supplies an invalid signature, the Geocoding API returns an HTTP 403 (Forbidden) error.

To troubleshoot individual URLs, you can use the URL Signing Debugger (opens new window). It allows you to quickly validate a URL and signature generated by your application.