Overview

Integrating with our platform is designed to be seamless and developer-friendly. Here's a brief overview to guide you through the process:

RESTful APIsCopied!

Our platform offers a comprehensive suite of RESTful APIs, ensuring predictable and resource-oriented interaction. These APIs have been meticulously designed to:

  • Utilize clear and logical URLs.

  • Accept form-encoded request bodies for simplicity.

  • Deliver JSON-encoded responses for easy parsing and integration.

  • Adhere to standard HTTP conventions, including response codes, authentication methods, and verbs.

Standard REST MethodsCopied!

When working with our APIs, you can expect to interact using the following HTTP methods:

  • POST: To create and send a new resource to the system.

  • PATCH: For updating or modifying an existing resource.

  • GET: To retrieve data or query resources.

  • DELETE: To remove or cancel a particular resource.

Getting StartedCopied!

To kick off your integration:

  1. Gain access to the Portal.

  2. Obtain your Authentication Credentials, which will be provided by your Alviere Program Manager.

With these in place, you're all set to begin building your application and taking full advantage of the services offered by our platform.