Rest API
Introduction
Refer to the general Rest API documentation. Link here.
Authentication
| API Key | Action Token |
|---|---|---|
Purpose | For admin calls (e.g. requesting action tokens) | For client operations (e.g. quality checks) |
Header key | x-api-key | Authorization |
Header value | "<your_API_key>" | "Token <your_action_token>" |
Refer to the general Rest API documentation for more information. Link here.
Errors
Refer to the general Rest API documentation on how to handle unhappy HTTP Status Codes. Link here.
Smart Care Limitations
The following limitations apply for the (initial) Smart Care implementation.
- We will not define "Users" (as described here in the general API documentation)
- Why? The concept of users implies that each patient has a seperate login and builds a user profile, tracking the person over time and learning insights. This concept is currently beyond the scope of this project.
Endpoints
{
"valid_minutes": 360
}error_code | error_type | Description |
|---|---|---|
1 | TOO_CLOSE | You're too close, move further away from the camera. |
2 | TOO_FAR | You're too far, move closer to the camera. |
3 | NOT_CENTERED | Align and center your face with the indication frame. |
4 | NO_CHEST | Your upper chest is not visible enough, make sure it's in the indicated frame. |
5 | BAD_POSE | Look straight to the camera. |
6 | BAD_LIGHTING | Good lightning is important. Make sure your face is well lit and the light is evenly spread on your face. Use the flash function if needed. |
7 | FOREHEAD_OUT_FRAME | Make sure your forehead is within the indicated frame. |
8 | NO_FACE_DETECTED | We couldn't detect a face. Make sure you are in the indication frame and lighting is good. |
9 | NO_FOREHEAD_SKIN | We couldn't detect enough qualitative skin area on your forehead. Please ensure it's visible, and the lighting on your face is evenly spread. Try again! |
Refer to the ZIP File Format documentation on how to format the ZIP file and content.
{
"face_scan_id": "832151dc-1b68-4077-97b0-88454f695653",
"patient_data": {
"ead": "abc-123456789"
},
"metadata": {
"field1": "value1"
}
}// Empty