Specifications

Development Requirements for API Calling Authentication

• Development tool versions:
  • IntelliJ IDEA: 2018.3.5 or later
  • Eclipse: 3.6.0 or later
  • Visual Studio: 2019 version 16.8.4 or later.
• Development language versions:
  • Java: Java Development Kit 1.8.111 or later
  • Go: 1.14 or later
  • Python: 2.7 or 3.X
  • JavaScript: Node.js of 15.10.0 or later
  • PHP: 8.0.3 or later
  • Android: Android Studio 4.1.2 or later
• Browser version: Chrome 89.0 or later
• SDK signature restrictions:
  • When you use the SDK to sign API requests, only the requests whose body is 12 MB or smaller can be signed.
  • When sending an API request, the SDK adds the current time to the X-Sdk-Date header and adds the signature information to the Authorization header. The signature is valid only within a limited period of time.
  • In addition to verifying the time format of X-Sdk-Date, ROMA Connect also verifies the time difference between the time specified by X-Sdk-Date and the actual time when the request is received. If the time difference exceeds 15 minutes, ROMA Connect rejects the request. Therefore, the client must synchronize the local time with the NTP server to prevent a large offset of X-Sdk-Date in the request header.

Custom Backend Development Requirements

• Function backends:
  • Only JavaScript can be used for function compilation, which complies with the Java Nashorn standard and supports ECMAScript Edition 5.1.
  • The maximum script size supported by a function backend is 32 KB.
• Data backends:
  • If a large amount of data is obtained by executing statements at a data backend, you are advised to add the offset and limit parameters for result paging to prevent response timeout caused by massive response data. The following shows the usage.

    select * from table01 limit '${limit}' offset ${offset}

    Keys of the offset and limit parameters can be transferred in the headers, parameters, or body of backend requests.

  • A maximum of 2000 records can be displayed on one page. You are advised to disable result paging.
  • The maximum statement size supported by a data backend is 32 KB.

Development Requirements for Backend Service Signature Verification

• Development tool versions:
  • IntelliJ IDEA: 2018.3.5 or later
  • Eclipse: 3.6.0 or later
  • Visual Studio: 2019 version 16.8.4 or later.
• Development language versions:
  • Java: Java Development Kit 1.8.111 or later
  • Python: 2.7 or 3.X

• SDK usage restrictions:
  • The Java SDK supports only basic and HMAC backend service signatures.
  • The Python SDK supports only HMAC backend service signatures.
  • The C# SDK supports only HMAC backend service signatures.