Overview

REST API

This documentation does not provide ways to test our API directly. We recommend the following tools:

• cURL
• Postman
• Web Browser, if you don’t need to send headers or request body

Once you prepare at least one tool, send a GET request to our API endpoint:

https://staging.resources.guizhanss.com/api/

{
  "name": "Guizhan Resources API"
}

If you get a similar JSON response above, you can use our API now! When you want to go live and use the production API endpoint, use resources.guizhanss.com instead of staging.resources.guizhanss.com.

Authentication

Many endpoints require authentication or return additional information if you are authenticated. Additionally, you can make more requests per hour when you are authenticated.

To authenticate your request, you will need to provide an access token with the required scopes or permissions. You can obtain an access token by creating an access token.

After obtaining an access token, you can authenticate your request by sending the token in the Authorization header of your request. For example, in the following Authorization header, replace YOUR-TOKEN with the access token you obtained.

Authorization: Bearer YOUR-TOKEN