1. Catalogs
  2. Routon Electronic Co.,Ltd.
  3. CompactSpeedGateManagementPlatform OpenAPI (V1.0)
video corpo

CompactSpeedGateManagementPlatform OpenAPI (V1.0)

CompactSpeedGateManagementPlatform OpenAPI (V1.0)
1 / 51 PagesView full catalog

CompactSpeedGateManagementPlatform OpenAPI (V1.0)

Product catalog summary
Overview: This document is a technical guide for the Compact Speed Gate Management Platform Open API (V1.0) by Routon Electronic Co., Ltd. It provides comprehensive instructions for using the API to manage access gates, employee lists, visitor management, and access records.
1. OAuth2 Authentication:
  • POST Obtain Token: Describes the process to obtain an access token using client credentials, including the response details such as access token, token type, and expiration time.
  • GET Open Interface Call Example: Provides an example of calling an open interface with parameters like corpId and Routon-Access-Gate-Token.
2. Access Gate Management:
  • GET Access Gate Group List: Details the parameters and response schema for retrieving a list of access gate groups, including access gate ID, name, server IP, and upgrade status.
3. Employee List Management:
  • GET Whitelist List: Instructions for retrieving a whitelist of employees, including parameters and response data schema.
  • POST Employee Save: Describes how to save employee information with required parameters and expected responses.
4. Employee Access Permission Management:
  • GET Access Permission List: Provides details on retrieving access permissions for employees.
  • POST Edit Access Permission Information: Instructions for editing access permissions with necessary parameters.
5. Visitor Management:
  • GET Visitor Management List: Details the process for managing visitor information, including saving and deleting visitor data.
6. Access Records:
  • GET Access Records: Instructions for retrieving access records with required parameters and response schema.
Key Points:
  • All API calls require specific parameters and return structured responses.
  • Authentication is handled via OAuth2 with client credentials.
  • Each section provides detailed parameter lists and response schemas to ensure proper implementation.
Additional Details:
  • Asynchronous Import Tasks: Parameters include 'ids' and 'source', with a successful response indicated by a 200 OK status.
  • Company Employee List: GET request to retrieve a list of company employees with parameters like 'corpId' and 'page'.
See more

Catalog excerpts

CompactSpeedGateManagementPlatform OpenAPI (V1.0)-3

For Basic authentication, the Username/Password are the clientId and clientSecret assigned by the system respectively. Body Parameters grant_type: client_credentials Response Examples 200 Response "resultCode": "SUCCESS", "language": "en-US",

 Open the catalog to page 3
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-4

"token_type": "Bearer", "expires_in": 7200 HTTP Status Code Meaning Description Data schema HTTP Status Code 200 Note: The development interface address starts with /open/api/ (except for the "Obtain Token" interface). The interface addresses in the document such as /admin/api/ or /portal/api/ need to be replaced with /open/api/.

 Open the catalog to page 4
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-5

Response Examples 200 Response "paramData": null, "paramData": null,

 Open the catalog to page 5
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-6

"paramData": null, "resultCode": "SUCCESS", "resultMessage": "Successfully obtained company configuration information" HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 6
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-8

1: Online, 0: Offline, others: All. Judged based on the minimum or empty reporting time of the Access Gate terminal Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Query successful", "totalSize": 15, "name": "Xianliurongshi", "serverIp": "71.24.138.92", "canUpgrade": 1, "channel": "Excepteur"

 Open the catalog to page 8
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-9

HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 9
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-12

Used to select a whitelist when modifying the access permission management policy.

 Open the catalog to page 12
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-13

3.1.3. Responses Data Schema HTTP Status Code 200

 Open the catalog to page 13
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-14

GET /admin/api/vl/accessGate/whitelist/staff/list Employee whitelist list

 Open the catalog to page 14
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-16

data: 0 or empty (default) - All, 1 -Yes, 2 - No Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Query successful", "totalSize": 15, "name": "lixiang", HTTP Status Code Meaning Description HTTP Status Code 200 Data schema

 Open the catalog to page 16
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-20

Name Location Type Required Description id query integer yes Whitelist ID Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Deletion successful" HTTP Status Code Meaning Description Data schema HTTP Status Code 200 When localFeature is 1, a .fea file is generated if the length is 1040, and a .floatfee file is generated if the length is 4112.

 Open the catalog to page 20
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-21

For local import without connecting to a 2117 device: if faceMaskFeature is empty and photoFileld is not empty, call the cloud to generate feature values based on the avatar; if not connected to the Internet, return "generate feature file failure".

 Open the catalog to page 21
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-22

Response Examples 200 Response "resultCode": "SUCCESS",

 Open the catalog to page 22
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-23

"resultMessage": "Saved successfully" HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 23
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-24

Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Deletion successful" HTTP Status Code Meaning Description Data schema

 Open the catalog to page 24
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-25

HTTP Status Code 200 id query integer no Employee staffId Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Success", "data": { "name": "Jixiaohou", "phone": "18626381938", "nickName": "Caiqiang", "idCardNo": "83", "rfCard": "et sunt ad laboris", "whitelistId": 32, "photoFileId": 2,

 Open the catalog to page 25
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-26

"photoFileUrl": "http://xxx" HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 26
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-28

Response Examples 200 Response

 Open the catalog to page 28
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-29

HTTP Status Code Data schema Query company access policies based on the company group where the user is located. Response Examples 200 Response

 Open the catalog to page 29
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-30

"resultCode": "SUCCESS", "resultMessage": "Successfully queried access policy list", "totalSize": 15, "name": "Jinglun Dianzi Tongxing Celue", HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 30
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-32

id query integer yes Access Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Query successful", "data": { "name": "Jinglun Dianzi Tongxi. g Celue', "beginDate": "2024-07-01",

 Open the catalog to page 32
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-33

HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 33
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-36

"resultCode": "SUCCESS", "resultMessage": "Successfully saved access permission information" HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 36
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-38

Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Successfully quei.ed visitor list", "totalSize": 15, "name": "lixiang", "inviter": null, "inviterName": "Suankuanggeanjia"

 Open the catalog to page 38
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-39

HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 39
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-40

Name Location Type Required Description id query integer yes Visitor record ID is Response Examples 200 Response "resultCode": "SUCCESS", "resultMessage": "Query successful", "data": { "name": "Nadangjianyi", "inviterName": "Xianyijingli", "beginDate": "2024-07-10", "endDate": "2024-07-10", "startTime": "10:00:00",

 Open the catalog to page 40
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-41

HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 41
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-43

Response Examples 200 Response "resultCode": "string", "resultMessage": "string", "data": { "name": "string", "phone": "string", "codeVisit": 0

 Open the catalog to page 43
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-44

HTTP Status Code Meaning Description Data schema HTTP Status Code 200

 Open the catalog to page 44
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-45

G ET /ad m i n/api/v 1 /accessGate/corp/staff/list Company employee list

 Open the catalog to page 45
CompactSpeedGateManagementPlatform OpenAPI (V1.0)-46

Response Examples 200 Response "resultCode": "54", "resultMessage": "Success", "datas": [ "name": "lixiang"

 Open the catalog to page 46
*Prices are pre-tax. They exclude delivery charges and customs duties and do not include additional charges for installation or activation options. Prices are indicative only and may vary by country, with changes to the cost of raw materials and exchange rates.