This section outlines how to get started quickly using HERE What3Words on the HERE platform:
- Get a HERE account
- Create a project
- Configure your project
- Send a request
This section provides information on the minimum setup required to quickly begin using HERE What3Words. For more detailed information on HERE account setup, project creation, service linking, app registration, and authentication, see the Identity & Access Management Guide.
Get a HERE account
If your organization has signed up for HERE Workspace or HERE Marketplace, contact your organization admin who can invite you to join the HERE platform organization established for your company. You can also request a free trial of the HERE platform if your company does not have an organization established for it. For more information, see the HERE platform pricing.
Create a project
To create a project, follow these steps:
- Sign in to the HERE platform using your HERE account.
- Open the Projects manager from the launcher.
- Click Create new project.
- Enter a name for the project. Project names don't have to be unique.
- Enter a project ID. Project IDs must be unique within an organization and cannot be changed for the lifetime of the organization. Project IDs must be between 4 and 16 characters in length.
- Enter an optional description.
- Click Save.
Get an API key
To get an API key, follow these steps:
- On the Resources tab, select Services and then click Link a Service.
- Search for services and click Link to link them to your project as needed.
- Click Done.
- Select the Access and permissions tab and click Grant access.
- Under New app, select Create.
- Provide an app name and click Register. The platform creates a new app with a unique app ID.
- On the Credentials tab, select API Keys and then click Create API key to generate a maximum of two API Keys for your application authentication credentials. The API key is created and displayed.
Send a request
The following are examples of requests:
What3words address to coordinates
Coordinates to What3Words
- Use HTTPS GET method only
- Remember to always URL encode your parameters
- Always include a valid API key in the
key=api-key parameter, or in the request header as
Access-Control-Allow-Origin: * header, that enables CORS.
If sucessful, you will get a 200 HTTP status code. If something went wrong, such as trying
convert-to-coordinates with an invalid 3 word address such as
no.address.here, you will get the appropriate HTTP error status (
400 in this case). Also, the body will contain an
error block with a
code and a
message code can be used programmatically so you can respond appropriately.
message is intended as a helpful message to help you understand how to fix what went wrong.
"message": "Invalid or non-existent 3 word address"
Oauth tokens are recommended for production. This example uses an
apiKey to allow you to quickly try the API.