📝 Overview

Welcome! Below is a detailed walkthrough of everything you need to integrate with the Alvys API. This tutorial covers account setup, authentication, and making your first API call.

🚧

Under Construction (Early Beta)

Please note that the contents of this document are subject to change as the contracts are finalized. This document does not represent the final version of any contracts or authentication workflows.

We aim to capture feedback before the official release in August.

☑️ Prerequisites

Ensure you have the following information before attempting to use the API:

• Client ID
• Client Secret
• Tenant ID (Tenant Code)

These credentials can be found in the Alvys Developer Portal or by reaching out to your account representative for more information.

🔒 Authenticating

Authenticating in Alvys is to confirm your account identity. The Client ID and the Client Secret are important credentials to authorize your application when making requests. These act as the security values to ensure your application and your account are linked together and the connection is protected.

To retrieve these credentials, you need to create a new application under the API settings section in your Account Settings:

1. Navigate to OAuth Applications.
2. Select Create New Application.
3. Enter the Name and Description for your new application credentials.
4. Locate the Client ID and Client Secret in your new application.

These credentials are used for generating a Bearer (access) Token, which is used to authenticate requests against the Alvys API.

Getting Access Token

To retrieve your access token, set up your authorization request. This example uses Postman configurations to get a new access token. Follow the steps below to configure your new token request.

Set up Callback URL.

1. Add Access Token URL:
   Text

   https://integrations.alvys.com/api/p/authentication/{tenant_id}/token
   

2. Add the Client ID.
3. Add the Client Secret.
4. Select "Get New Access Token."

To collect your access token, proceed through the OAuth 2.0 authorization prompts from the callback URL. Additional information is available in the Authentication section.

Postman Public API Collection

We are also sharing a Postman Public API Collection for testing purposes. This collection allows you to interact with the Alvys API easily. However, please remember to replace the token generation data with your own credentials to ensure proper authentication.

To fork the collection, click the embedded Run in Postman button below (wait a few sec.), and on the fork collection page, click the button to add the collection to your Postman account.

You can use Run in Postman button to quickly import our Public API collection into your Postman workspace. Be sure to replace any placeholder values (like client_id, client_secret, and tenant_id) with your own credentials before making requests!