Quick Start

This chapter helps you complete a working Open API request as quickly as possible.

Step 1: Prepare credentials

1. Sign in to the platform.
2. Open the "My OpenAPI Private Key" page.
3. Copy the following values:
   • The current user id
   • The matching OpenAPI private key

Notes:

• The server stores the paired public key for verification.
• The private key should only live on the server side or in another secure environment.
• After a key reset, the old private key becomes invalid immediately.

Step 2: Prepare the base URL

Local development usually uses:

http://localhost:3000/api/open

Replace it with your production domain in a deployed environment.

Step 3: Build the signing headers

Every request must include these headers:

• x-user-id
• x-timestamp
• x-sign

Use headers consistently instead of mixing headers and query parameters.

Step 4: Send a read request

curl --request GET \
  --url 'http://localhost:3000/api/open/documents?page=1&pageSize=10&published=true' \
  --header 'x-user-id: your-user-id' \
  --header 'x-timestamp: 1743400000000' \
  --header 'x-sign: your-signature'

Step 5: Verify the response

A successful response contains:

• data: document list
• pagination: pagination metadata

Common failure causes

• Missing signing headers
• The private key does not match the user ID
• The timestamp differs from server time by more than five minutes
• The signed request body does not match the body actually sent