Release History API version ： 1.2.7 Version on server ： 2.7.0 Version on local host ： 2.9.1 Section Type Description 2.8 Add Interface for deleting user database 2.9 Add Interface for judging quality of loading images 2.10 Add Interface for finishing photo taking and user registration 11.2 Add Interface for dynamic 1:1 comparison 11.1 Modify Support POST callback for return values of local host information API version ： 1.2.6 Version on server ： 2.0 Version on local host ： 2.8.0 Section Type Description 4.1 Modify Add paging parameters 11.1 Modify Modify output data 11.2 Delete Not supported in new firmware anymore 11.3 Delete Not supported in new firmware anymore API version: 1.2.5 Version on server: 1.5 Version on local host: 2.6
Section Type Description 9.1 Delete Deprecate interface and suggest using 11. video streaming recognition Delete sample programs, please access API related samples 11.1 Modify http://techsupport.megvii.com/hc/kb/section/105584/ API version: 1.2.4 Version on server: 1.5 Version on local host: 2.6 Section Type Description 11.2 Add The section is newly added 11.3 Add The section is newly added API version: 1.2.3 Version on server: 1.5 Version on local host: 2.6 Section Type Description 11.1 Modify Description is updated API version: 1.2.2 Version on server: 1.5 Version on local host: 2.6 Section Type Description Modify and mark as Transport of socketio can only use websocket type, polling 9.1 Deprecated cannot be used API version ： 1.2.1
Version on server ： 1.5 Version on local host ： 2.6 Section Type Description 7.2 Modify Add paging parameters 2.7 Modify Add ‘quality’ and other data in return values API version: 1.2 Version on server: 1.5 Version on local host: 2.6 Section Type Description 10.1, 1:N recognition Modify Add “screen” in return values API version: 1.1 Version on server: 1.4.2 Version on local host: 2.5 Section Type Description Document Format Modify Document format cleanup Index I ． Server API Function Method Interface url Interface function 0. Error handling 1. Login POST /auth/login 1.1 Login
I ． Server API Function Method Interface url Interface function GET /mobile-admin/subjects 2.1 Get all user lists /mobile- 2.2 Get user list (support get by pages or GET admin/subjects/list/ categories) POST /subject 2.3 Create User GET /subject/[id] 2.4 Get User Information PUT /subject/[id] 2.5 Update User Information 2. User Database Management DELETE /subject/[id] 2.6 Delete User POST /subject/photo 2.7 Upload recognition photo DELETE /subject/photo 2.8 Delete user database POST /subject/photo/check 2.9 Quality check for uploaded photos 2.10 Create User (support uploading POST /subject/file images directly) 3. User Avatar POST /subject/avatar 3.1 Uploading and displaying user avatar Management GET /system/screen 4.1 Get access control list GET /system/screen/[id] 4.2 Get access control information GET /system/boxes 4.3 Get all available local hosts 4. Access Control Management POST /system/screen 4.4 Create access control setting PUT /system/screen/[id] 4.5 Update access control setting DELETE /system/screen/[id] 4.6 Delete access control setting
I ． Server API Function Method Interface url Interface function 5. Historical GET /event/events 5.1 Historical recognition record record 6. Attendance GET /attendance/records 6.1 Attendance record record /statistics/overview GET 7.1 Age and gender statistics （ Deprecated ） 7. Age and gender analysis （ Deprecated ） /statistics/event GET 7.2 Age and gender record （ Deprecated ） POST /pad/login 8.1 Login 8. Pad interface POST /pad/add-visitor 8.2 Add visitor PUT /pad/set-info 8.3 Set Pad information 9. Recognition 9.1 Recognition message push push socket.io /event/ （ Deprecated ） （ Deprecated ） II. Local host API Function Method Interface url Interface function POST /recognize 10.1 1:N recognition 10. Static recognition POST /checkin 10.2 1:1 authentication ws://[ 本地主机 11.1 Get recognition result (websocket websocket 11. Video ip]:9000 interface) streaming recognition POST /video_verify 11.2 Dynamic 1:1 interface Appendix
I ． Server API Function Method Interface url Interface function III. Model definition IV. Error code definition V. Paging information definitions Identifier clarification Identifier Clarification code 0 indicates normal, other codes can reference error code definition id Database index subject Recognition objects: staff, visitor avatar Avatar photo of the “subject” photo Recognition photo uploaded for the “subject” box Host box network_switch Network switch screen One channel of Facial Recognition camera Note : API address is: http://<host ip> Unless otherwise specified, the parameters of all interfaces are in JSON format in this document. Additionally, format Content-Type should be converted into application/json. I. Server API 0. Error handling
Not login HTTP 302 redirect will be returned when calling other interfaces if the login interface was not called, which can be used to check whether login or not. No permission If a logged-in account has no permission to call one interface, HTTP 302 redirect will be returned when calling the interface. 1. Login 1.1 Login URL: /auth/login Method: POST Description ： Login and acquire a cookie, then all interfaces should pass the cookie in when the interfaces are called. Parameters: Parameters Type Required Description username str √ Email password str √ Password This interface should set user-agent as “Koala Admin”, otherwise login cannot be successful. Return value description:
Field Type Specification avatar str Avatar address company_id int Company ID password_reseted bool Save password or not role_id int Account type: 1. Root, 2. Administrator, 3. User username str Username Return JSON ： { "code": 0, "data": { "avatar": null, "company_id": 1, "id": 2, "password_reseted": true, "role_id": 2, "username": "user@megvii.com" }, "page": {} } 2. User Database Management 2.1 Get all user lists URL: /mobile-admin/subjects Method: GET Description:
Get list of all users in user database, visitors are included. Parameter: None Return value description: Returned data field is a subject object list, the meaning of subject field can be referred to “Definition of subject” part in “III. Model definition”. Return JSON: { "code": 0, "data": [ { "avatar": "", "come_from": "", "company_id": 1, "department": "", "description": "", "email": "dyg@megvii.com", "end_time": 0, "gender": 0, "id": 4, "interviewee": "", "name": "dfds", "password_reseted": false, "phone": "", "photo_ids": [ 4 ], "photos": [ { "company_id": 1, "id": 4, "subject_id": 4, "url": "/static/upload/photo/2015-10-13/3ee5d084439065548440749c334957e3fdaa0132.jpg" } ], "purpose": 0, "start_time": 0, "subject_type": 0, "title": "" } ],
} 2.2 Get user list (support get by pages or categories) URL: /mobile-admin/subjects/list Method: GET Description ： Get specific user information according to given parameters. Parameter ： Parameter Type Default Required Description category string None √ staff; visitor; VIP visitor Chinese name or Pinyin of users name string None waiting for screening Ordering method: ‘time’ – ordering by reverse chronological order order string 'time' according to creation time; ‘name’ – ordering by English or Pinyin dictionary order page int 1 Page size int 10 Pagesize int Return value description: A subject object array is returned, the meaning of the subject field can be referred to “Definition of subject” part in “III. Model definition”. Return JSON ：
{ "code": 0, "data": [ { "avatar": "", "come_from": "", "company_id": 1, "department": "", "description": "", "email": "dyg@megvii.com", "end_time": 0, "gender": 0, "id": 4, "interviewee": "", "name": "dfds", "password_reseted": false, "phone": "", "photo_ids": [ 4 ], "photos": [ { "company_id": 1, "id": 4, "subject_id": 4, "url": "/static/upload/photo/2015-10-13/3ee5d084439065548440749c334957e3fdaa0132.jpg" } ], "purpose": 0, "start_time": 0, "subject_type": 0, "title": "" } ], "page": { "count": 757, "current": 1, "size": 10, "total": 76 } } } 2.3 Create User URL: /subject
Recommend
More recommend
