How it Works

How It Works

This topic describes how to get started with the Anywhere API products.

1. Choose an API Product

Get started by choosing a required API. Go to the API Products and select an API product.

The API product is displayed using the following labels:

  • Public:The API product is available to all users.
  • Private:The API product is available to only Anywhere internal users.
  • Partner:The API product is available to Anywhere internal users and select Anywhere partners.

If you wish to use an API product in production, then view the API product requirements for the particular API product, and ensure that you comply

 

2. Sign up

To use a Anywhere API product, you must simply register for free in our portal and create an account or just login with your registered Anywhere ID

To register and create an account:

  1. Register on developer portal using Sign Up.
  2. Enter your details and click Create New Account.
  3. Developer Portal will send you an activation link by email.
  4. Use the activation link and Log on to the portal

 

3. Register an Application

To use a Anywhere API product in the sandbox environment, or develop your idea into production, you must first create an application (APP) in the developer portal and associate it with the API product. The sandbox environment is where you test the functionality of an API. We are delighted to see the great things you’ll create.

To create an application for getting API credentials:

  1. Log in to your account.
  2. Go to dashboard and use "My Apps" to view api credentials or use "Get API Credentials" to request new API product access for any API product. 
  3. Click + Add App. 
  4. Select API product and Environment and Company/Group/Team. You can select the company from dropdown in case you have multiple company groups. If you are not associated with any company and group, then you can enter unique Company/Group/Team (recommended format for use: CompanyName-TeamName).
  5. In the  Prefix App name field, enter a name for your application.
  6. Submit the form. Upon submission, Anywhere will review and approve the request and you will be notified of the same in email. 
  7. You can access your API credentials in "My Apps" section and use the same to access API product.

Your request for Sandbox access will undergo Anywhere approval process which may take up to 2 business days. You will be notified via email when the request is actioned on (Approved/Rejected).

If you want to view the status of your application, then go to My Apps page. You can also view related information such as the applications API key and the credentials. The API key and credentials needs to be used to access products that are associated with your application.

 

4. Develop and Test your Application

Now, you are ready to develop. You can safely try all API functionalities by accessing our sandbox environment.

For a step-by-step guide on how to use a specific API in the sandbox environment, go to the related API product documentation. To view all available APIs, go to the API Products page.

Once you complete development, please complete your testing, and plan for next steps.

 

5. Go Live

Now it’s time to release your application. We are excited to see your results. To go live with your application in a production environment:

  1. Go to the API Products page and open the product documentation.
  2. In the Requirements section, ensure that you comply with all points.
  3. In the Production access section, complete the steps.

Your request for Production access will undergo Anywhere approval process which may take up to 2 business days. You will be notified via email when the request is actioned on (Approved / Rejected).

 

6. Give Feedback

We are open for your valuable feedback so that, we can further improve our services. If you are interested in any of our products or need to give feedback, then you can always contact us.