Skip to main content

API

API (Application Programming Interface) refers to a number of pre-defined functions designed to provide applications and developers with the ability to access a set of routines based on a software, while not having to access the source code or understand the internal workings mechanism. Users can access the information by calling the API in a defined format.

HAP currently supports the following two module-related APIs.

1. Organization​

It refers to the interfaces in the organization that are related to member and departments, reporting relationships, logs, to-dos, applications, and other data. Currently such set of key information can only be viewed and managed by the Organization Administrator, [Org Admin] > [Integration] > [Misc.] > [Organization Key].

2. Application​

After an application is created, the corresponding API is automatically created and the Application Administrator can view the interface documentation.

The interfaces are listed below:

  • Application

    • Get application information GET

  • Worksheet

    • Create worksheet POST
    • Get worksheet structure POST

  • Record

    • Get records list POST
    • Create record POST
    • Batch create records POST
    • Get record details GET
    • Get record details POST
    • Update record details POST
    • Batch update record details POST
    • Delete record POST
    • Get associated record POST
    • Get sharing link POST
    • Get total number of rows in a worksheet POST

  • Roles in Application

    • Get roles list GET
    • Create role POST
    • Delete role POST
    • Add member POST
    • Remove member POST
    • Exit application POST

Share Application API​

Application Admis can open the API documentation and then click the Share button to share the document.

  • In the shared API page, all key information will not be displayed. In the examples, key information will be shown as "YOUR_APP_KEY" and "YOUR_SIGN".
  • When sharing, you can set the expiration date and password for the link.

API QPS​

Currently, the call frequency is limited to the same IP address, not to a specific application or user. If exceeded, the call will not be possible, which may affect your business, so please make calls reasonably.

InterfaceQPS per IP
Create Record (addRow)20
Batch Create Records (addRows)20
Edit Record (editRow)20
Batch Edit Records (editRows)20
Get Record List (getFilterRows)50
Other InterfacesNo limit
Private DeploymentNo limit
  • If to get a list of records through API, support up to 1000 records.
  • If to batch add, batch update, and batch delete records through API, support up to 1000 records.
  • If to write files (Base64) through API, for the file size, support up to 7MB.

Have questions about this article？ Send us feedback