Quick Start

To get the data provided on this platform, please follow the steps below:

Step 1: Register

First of all, you have to apply to use this service.

1. Go to ICTO Account Information Page.

2. Select “Manage Account”.

3. Select “NOT APPLY” to list the items not yet applied for.

4. Click “OPEN DATA API PLATFORM”, read the agreement, and apply.

5. Please wait for up to one hour for it to take effect.

Notes

• If “OPEN DATA API PLATFORM” is under the "REGISTERED" page, it means you have registered.

Step 2: Sign in

1. Click "Sign in" in the menu at the top right corner.

2. Please read the Terms and Conditions of Use if you have not read them before.

3. Click "Sign in with UMPASS" button.

4. In the Microsoft "Sign in" page, input your UserID with the UM domain (e.g., userid@um.edu.mo). Click "Next".

5. You will be directed to UMPASS Authentication Service page. Your UserID should be filled in automatically. Input the password and click "SIGN IN".

6. You will be directed to the home page of this platform if you successfully sign in.

Notes

• If you are newly registered (as mentioned in Step 1), please wait for up to one hour for it to take effect.

Step 3: Get data from a data set

1. Go to the Data Set page and find your interested data set.

2. If it's an API, please follow Step 4, 5 and 6. If it's available in file format, please follow Step 7.

Step 4: Subscribe a Product for accessing data with API

1. Go to the Products page.

2. Click "UM Members".

3. In "Your subscriptions", input a "production subscription name".

4. Please read the Terms and Conditions of Use if you have not read them before. Then, check the box to agree.

5. Click the "Subscribe" button. Then, you will be directed to the Subscriptions page, which shows the details of your subscriptions.

Step 5: Obtain the authentication token

1. In the Subscriptions page, for a subscription item, either click the "Show" link of "Primary key" or "Secondary key". Please use the key as the value of "Authorization" key while calling an API.

Step 6: Obtain the API URL

1. In the Data Set page, select an API.

2. Then, you can find the API link under the "Request" section and related parameters (if any).

3. To try an API, click the "Try it" button on the right-hand side and try it directly.

4. To use the API, please check the API General Operations.

5. To know more about the data definition of a data set, please check the Data Dictionary.

Step 7: Get data in file format

1. In the Data Set page.

2. Click the "Download" button of a data set in "Files" section.

3. You will be directed to OneDrive storge platform and can download the data you are interested in.

4. To know more about the data definition of a data set, please check the Data Dictionary.