Skip to main content

API Access Token

What is an API access token?​

An access token is issued to grant access to 3rd party. Disabling ID requires an API token first, so an API token must be generated. It's called an API access token.

Why do we need an API token?​

The API token is required to grant access to 3rd parties. When disabling one's device ID, an API token is required to create a compliance client profile for the first time. For that, an API token has to be generated. The API token is required for compliance with the client profile.

How to use an API token​

The ID can be disabled using an API token and an API token for the ID needs to be generated. Following are the steps on how to generate an API token and how to use it.

How to create a new API token​

  1. First, we will go to its portal which here is the dev.CLOUDS (https://dev.hi-clouds.com/login) and beta.ClOUDS (https://beta1.hi-clouds.com/login). So first go to dev.CLOUDS. create new API token 1

  2. If there are features, we will go there if there is a feature in the name of Manage API. create new API token 2

  3. After going to Manage API you will see a screen-like image.

    • Allowed API: What you want to give allowed API here has to be added here.

    • Blocked API: What you want to give blocked API here has to be added here.

    • Allowed IP: What you want to give allows the IP address to be added here.

    • Blocked IP: What you want to give a blocked IP address here has to be added here.

    create new api token 3

  4. After that click the "save" button here.

    create new API token 4

API Tour​

Main window​

  1. The CLOUDS dashboard is visible in the figure.

    create new API token 1

  2. There you can see CLOUDS Name, Platform version name, Time, Date, and Location on the left side.

    main api1

  3. You can see how many users, how many CE, and how many sites there are.
    main api2

  4. You can also see the map there. There on the left side, you can see different futures. main api3

  5. There you can edit the API by going to Manage API futures.

    create new API token 2

How to allow API​

  1. Go to API to allow Manage API. After going to manage API, click on "Add New API Token" shown on the right side.

    allow API 1

  2. Click on add new button then you will see something as shown in the image there select the new API you want to allow here.

    allow api2

    allow api3

  3. Then Click on the "save" button in the list below.

    allow API 4

Example​

  1. Ex:1 allow api ex1 allow api ex2 allow api ex3

How to block API​

  1. Go to API to allow manage API after going to manage API, click on add new API token shown on the right side.

    allow API 1

  2. Click on the add new button the you will see something as shown in the image there select the blocked API you want to allow here.

    block api 2

    block api 3

  3. Then click on the "save" button in the list below. block API 4

Example​

  1. Ex:1

    block api ex1
    block api ex2
    block api ex3

How to allow IP​

  1. Go to the add new button as shown in "How to allow IP" and "How to block IP" allow API 1

  2. Then add the IP address you want to access as shown in the image. allow ip

  3. And then click on the "save" button in the list below. allow ip 2

Example​

  1. Ex:1

    allow ip ex1 allow ip ex2 allow ip ex3

How to block IP​

  1. Go to add new button as shown in "How to allow IP" and "How to block IP". allow API 1

  2. Then add the IP address you want to access as shown in the image. block ip

  3. And then click on the "save" button in the list below. block ip2

Example​

  1. Ex:1

    block ip ex1 block ip ex2 block ip ex3

What is token expiry?​

If the date of the given token is gone, then the API token becomes invalid, i.e. it expires. such a token is called an expired token.

How to token Expiry​

  1. Go to manage API. how to token expiry 1
  2. After going to Manage API, click on the edit option of the API you want to expire. how to token expire 2
  3. After clicking on the edit option, if you scroll down a little, you will see something as shown in the image. how to token expiry 3
  4. And from there you can change the date of your API. And then click on the "save" button. how to token expiry 4

How to update the token​

  1. When you want to update the given token then go to manage API as shown in the below image. how to token expiry 1

  2. Then the right side pen of the API you want to update is given an option. clicking on it and from there you can update your token. how to token expire 2 update 1

  3. Fill in your updated information and click on the "save" button given below. update 2

How to delete the token​

  1. When you want to update the given token then go to manage API as shown in the below image. how to token expiry 1

  2. Click on the option as shown in the image on the right side of the API of the token you want to delete.

  3. When you click on it you will see something like this. delete1

  4. After that click on "yes". if you click on yes, your given token will be deleted. delete2

How to use API access token with compliance client​

How to generate API token should be generated as shown in "how to new API token".

  • How to use API access token with compliance client

  1. Installing the compliance client application as explained in "How to install compliance client app in windows."

  2. The generated API has to be added inside the compliance client.

  3. When you go to the compliance client's profile and go to the setting as shown in "How to configure the profile", you will see something as shown in the image,

    how to config profile

  4. There you need an API token, name, language, and URL as explained in "How to configure the profile". Also, the newly generated API token will be added here.

  5. After that click on "save" button.

  6. There you will see a message on the screen as shown in the image that your profile is saved, click on "ok". use 1