Welcome

Welcome to the TIER API Version 2 - Beta.

This documentation provides the essentials to integrate with TIER’s Mobility API Version 2. Beta because the API is production ready, but might be subject to minor changes. TIER will consecutively add the version 2 endpoints here.

Please find the current documentation for /v1 below under TIER API Version 1.

Please find the former version of the documentation for /v1 here: https://documentation.tier-services.io

ℹ Access is limited for different endpoints and zones for each API key individually.

Format

The TIER API is using the JSON:API standard.

Versioning

The API is versioned using a prefix in the URL, e.g. /v2 for the second version. There are still some unversioned (deprecated) endpoints. If you are using these, please note that they will stop working in future releases of this API.

Please always use the newest API version and contact us when there is a reason why you cannot switch to a newer version.

Please find the documentation for /v1 below under TIER API Version 1.

Please find the former version of the documentation for /v1 here: https://documentation.tier-services.io

Backwards-Compatible Minor Updates

We will only break backwards compatibility in new API versions, which have their own URL prefix. That means that all actions or resources will remain backwards compatible as long as your integration allows for the following changes to be made on our side:

• An endpoint resource might return new fields, e.g. {"foo": "bar"} might be {"foo": "bar", "baz": 123} tomorrow
• An endpoint might accept new optional data or parameters
• An endpoint might ignore previously required data while providing same functionality

Terms & Conditions

Please find our current Terms & Conditions here: https://www.tier.app/terms-and-conditions-unbranded/

Users have to accept these Terms & Conditions before using our services.

Please find our e-moped-specific Terms & Conditions here: {link will follow soon}

Users have to accept these Terms & Conditions before using e-Mopeds.

Privacy Policy

Please find our current Privacy Policy here: https://www.tier.app/privacy-policy-unbranded/

Users have to accept this Privacy Policy before using our services.

FAQs

Please find the Frequently Asked Questions (FAQs) for TIER Mobility here.

What changes for e-Mopeds?

Production and staging URLs

Please note that there are 2 different URLs for our staging and for our production environment.

Our production environment is accessible via https://platform.tier-services.io/v2.

ℹ Please note that we have currently disabled our staging environment. Your requests to https://platform.tier-staging.io/v2 will not get any responses as of now.

ℹ Note that production and staging environments do have different API keys.

Authentication

You must replace TIER API KEY with your personal API key.

TIER is using an API Keys and JSON Web Token (JWT) based authentication, depending on the endpoint. To register for an API key please ask your TIER contact. Each API key is bound to certain permissions that determine which zones and endpoints you can access.

---