Primas CX User Guide
Space shortcuts
Page tree
Skip to end of metadata
Go to start of metadata

Step-by-step guide

  • Go to Linkscope Web application and if you're not already signed in, select Sign in.

  • From the Linkscope Web application, you click to Configuration → General →  API User at the menu. 


 ADD NEW AN API USER

  1. Click the  button, the Add popup is displayed.

  2. At the Add popup, input your Auth Type, User Name, Password, and Note. Select Permission in the right tree view. Then click the Update button.



     If the system shows this message, you created successfully an API User.

CHANGE AN API USER'S PASSWORD AND PERMISSION

  1. On the API User List table, select any row you want to change an API User's Password and Permission.



  2. Click the  button on that row. The Edit popup is displayed. 

  3.  At the Edit popup, enter your new information and select another Permission in the right tree view. Then click the Update button.



    If the system shows this message, you edited successfully an API User.

DELETE AN API USER

  1. On the API User List table, select any row you want to delete an API User.



  2. Click the  button on that row.

  3.  There're alert displays after you click on this button. Select OK.



    If the system shows this message, you deleted successfully an API User.


SEARCH FOR AN API USER

On the API User List table. You can search for an API User by searching the User Name or Password or IP Address field.

  1. Search by the User Name field:



  2. Search by the Password field:



  3. Search by the IP Address field:


IMPORT FROM/ EXPORT TO AN EXCEL FILE


  • To import data from Excel file: 
  1. At the select file (.xls) label, click the Select files button.



  2. Select an Excel file that you want to import and click the Open button.



  3. Click the Import button.



  • To export data from Excel file: 
  1. On the page below, click the Export Excel button.



  2. The exported file will auto-save to Downloads folder with the name APIUserData.xls:

AUTHENTICATION TYPE

Currently, we have 3 types of authentication: 

  • User Only: using User Name and Password to authenticate the API
  • IP Address Only: using a list of IP addresses to authenticate the API (each IP address is separated by ',' characters, e.g.: 192.168.1.1,192.168.1.2,...)
     
  • User & IP Adress: using all User Name/Password and a list of IP addresses to authenticate the API
Get Authorization code:

When using the User type to authenticate the API, we need to get an authorization code by clicking on the button to copy the token to the clipboard:

Using Authorization code:

Add the authorization code to The HTTP Authorization header: Authorization: Basic <Authorization code>

Example:

Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l

or

Authorization: WxhZGRpbjpvcGVuc2VzYW1l