API Integration - Getting Started Guide

This guide provides instructions for integrating with Resolution Intelligence Cloud APIs. It is intended for active subscribers of Resolution Intelligence Cloud.

Prerequisites

Before beginning your API journey, ensure the following:

1. Access to Resolution Intelligence Cloud: Active customer status in RIC.
2. Active Subscription: Confirm an active Add-on Subscription for API consumption.
   Contact Netenrich CSM or Sales Team for assistance if needed.

Plans and Rate Limiting

Follow the below steps to choose right add-on for your existing subscription.

1. Add-on Plans: Select the subscription plans based on your needs.
2. Rate Limiting: Familiarize yourself with the rate limits of your chosen plan to ensure service stability and fair usage. For more information or to learn about additional add-ons, please connect with your CSM or sales team.
3. Selecting a Plan: Consider criteria such as rate restrictions when choosing an API add-on plan.

API Credentials

Register your application at the Resolution Intelligence Cloud to receive a unique client ID and a confidential client secret. Keep these credentials safe as they are essential for API access.

Create & Manage your API Keys

To create and manage API keys, follow these steps:

1. Log in to Resolution Intelligence Cloud with Admin Credentials.
2. Navigate to Configurations and then click Authentication under Account Information. This takes you to the Authentication page. 
3. Click the Platform API keys tab to create an API key. 
4. Click Create API key. This takes you to the Create an API key page where you can generate new API keys.
5. Enter the API key name and description.
6. Select the access type you want to provide the user to accounts and objects. 
7. Select the Full access radio button in accounts to provide full access to all the resources in accounts or select the Read radio button to provide only read access to the resources in accounts. Follow the same to access object resources.  

8. Click Submit to generate the API key and API ID. Use the copy icon to copy the API key to invoke the accounts and objects API. 

Note: You can only view the API key once. If lost, you must generate a new one. 

Deleting an API key

Use this procedure to delete an API key.

1. Navigate to Configurations and then click Authentication under Account Information. This takes you to the Authentication page. 
2. Click the Platform API keys tab to view the existing platform API keys or to create a new API key. 
3. Click the ellipses icon and select Delete corresponding to the API key you want to delete. The dialog box appears prompting to proceed with this action.

4. Click Yes to delete. 

Viewing the summary of an API key

Use this procedure to view the summary of an existing API keys. 

1. Navigate to Configurations and then click Authentication under Account Information. This takes you to the Authentication page. 
2. Click the Platform API keys tab to view the existing platform API keys or to create a new API key. 
3. Click the ellipses icon and select Summary corresponding to the API key. 
4. Review the following details in the API keys Summary window:
   1. • API Key Name - The name of the API key.
      • Client Id - A unique ID generated for the API key. 
      • Scopes - The access that this API key is providing users. 

Example API Calls

Example 1: Listing Accounts

curl --location 'https://api-stage.netenrich.com/api/v1/accounts \ ?select=accounts|features|subscriptions|usage_metrics \

 --header 'authorization: Basic base64encoding(clientId:clientsecret)

 Example 2: Listing ActOns

curl --location 'https://api-stage.netenrich.com/api/v1/objects/actons \

?since=now-2d&until=now' \
--header 'authorization: Basic base64encoding(clientId:clientsecret)

401 Unauthorized: If you receive the 401 error, ensure that the client authentication follow the specified format in the above request. 

403 Forbidden: If you receive the 403 error, check whether API key has an access permission to perform the request.

Response Codes

APIs responds with standard HTTP response codes. When you call an API, it gives a response code that it received the message or provides an error which help you troubleshoot the API.

The following table show the description along with HTTP codes that are followed by the Open API specification standards. Refer the specific API references to know about the successful or error messages where applicable.

Status	Message	Description
200	OK	Shows a successful message with JSON payload
201	Created	A new resource created
204	No Content	No content available to send the request
400	Bad Request	Invalid requests. You may have missed an mandatory parameter in the JSON and ensure that you should not miss it.
401	Unauthorized	A token is invalid or missing. Ensure that you provide a valid token along with correct HTTP headers.
403	Forbidden	The API key doesn’t have permissions to perform the request.
404	Not Found	The request source doesn’t exist, or endpoint is missing.
409	Conflict	Your request is overlapped with another (may have same idempotent key).
410	Gone	Requested resource is no longer existing or removed permanently.
500	Internal Server Error	Netenrich servers are busy or not available now. Try after some time.
501	Not Implemented	Your API method is unsupported. Try again with a correct method.

API Catalogue

Explore the diverse range of APIs available on the Resolution Intelligence Cloud API Catalog at  https://devportal.netenrich.com/. Test environment credentials are required for access.