Introduction

This guide outlines the steps required to migrate your application from API v1 to v2. The upgraded API v2 contains new features, clear documentation and improved functionality that will enhance your application’s performance and usability. At first, a migration can seem daunting but this guide will provide you with a roadmap to ensure a smooth transition. This guide sets out the most common differences between API v1 and v2, and should not be taken as exhaustive. If you do have any difficulties during your migration process or you spot a bug or any unexpected behaviour not documented below, please contact developers@amiqus.co.

If you are a new Amiqus integration client, please see the API v2 spec here.

Concepts

Please refer to the Concepts guide to account for key aspects that apply universally to all endpoints of the Amiqus API in your integration. These concepts will replace what was previously available for v1. For example, wherever your integration uses an endpoint that returns a list please see Pagination.

Authentication

Good news 🥳 Authentication will remain the same in across all current versions of the API. Your application’s existing valid tokens will also work to access API v2.

To read more about the different types of authentication available and how to implement them, see here.