Simplifying Access to ADVANCE Face Search APIs - Common Queries Answered

1. What is the purpose of the ADVANCE Face Search API? The API provides tools for facial recognition, including creating face sets, managing face data, and performing face similarity searches.

2. How can I get started with the API? Start by generating an access token using the Token Authentication API. Include the token in the X-ACCESS-TOKEN header for all requests.

3. What are the prerequisites for integrating with the API?

• Obtain accessKey and secretKey from your account on the WebSaaS Platform.

• Generate a signature by combining and encrypting accessKey, secretKey, and a timestamp.

4. What is the response structure for API calls? The response contains fields such as code, message, data, and additional debugging information in the extra field.

5. How do I ensure my requests are correctly authenticated? Ensure the timestamp in the signature matches the request's timestamp parameter. Tokens expire after their validity period, so renew them as needed.

6. Can I retrieve an individual face's details? Yes, use the Get face by ID API by sending a GET request to /intl/openapi/face-search/facereferences with the id parameter.

7. How do I delete a face from a FaceSet? Send a POST request to /intl/openapi/face-search/facereferences/delete with the id of the face and the faceSetId.

8. How do I debug common API errors?

• PARAMETER_ERROR: Verify required fields and their formats.

• ACCOUNT_DISABLED: Ensure your account is active.

• CLIENT_ERROR: Check for bad request syntax.

9. What pricing strategies apply to API usage? Responses include a pricingStrategy field indicating whether the request is FREE or PAY. Charges are based on the type of response.

10. Where can I find examples of request and response formats? The API documentation includes code samples and JSON response examples for all endpoints.

11. How do I manage image quality for face searches? Ensure images meet the resolution (256x256 to 4096x4096), format (jpg, png, jpeg), and size (under 2MB) requirements.

12. What should I do if my token generation fails? Common issues include:

• Missing or empty parameters.

• Timestamp discrepancies.

• Incorrect signature generation.