riverty logo

Docs

Environments and Access

##Environments and Access

There are two environments that Riverty AaaS maintains

  1. UAT : The UAT (pre-Prod) environment is the right environment to work with when implementing and testing the integration with Accounting as a Service.
  2. PROD : It is LIVE environment that processes live transactions, which can only be accessed after integration is complete.

##Endpoints
UAT : https://api-uat.accounting.riverty.io

PROD : https://api-explorer-uat.accounting.riverty.io

##Authentication

To start using the Accounting as a Service API, follow these steps:

1. Sign Up for a Sandbox Environment

First, you need to create a dedicated user account for the UAT environment (Sign up - AaaS - API Explorer). This is required before you can access any API services.

After signing up, you will receive an email with a confirmation link. Click on the link to verify your account.

2. Sign In to the API Explorer (UAT Environment)

Once your account is confirmed, go to the API Explorer for the UAT environment and log in with your credentials.

3. Generate the Subscription Key
After signing in, navigate to the products section. Select your product (Sample client in case of integration, your company name in case the merchant has already been onboarded ). Give a name to your subsription key and click the button “Subscribe”. Your key will be generated and be ready to be used.

4. (OPTIONAL) Retrieve Your Subscription Keys

After signing in, navigate to your user profile in the API Explorer. Here, you will find and manage your subscription keys, which are required to authenticate all API requests.

5. Use Your Subscription Key for API Requests

When making requests to the API, you must include one of your subscription keys as authentication.

##Request Access to the Production (PROD) Environment

If you need access to the PROD environment, you will need to:

Sign up for a separate PROD account.

Confirm your email.

Access to the PROD environment needs approval from our team and it is approved only when the onboarding and testing phase has been completed and signed off by responsible authrority within AaaS.

Log in to the PROD API Explorer to retrieve your PROD subscription keys.