Welcome to Face Scan PPG Data Delivery Documentation

Welcome to the documentation for Face Scan PPG Data Delivery. This documentation provides detailed information about how HiQOR delivers processed health assessment data to your systems, API endpoint requirements, and how to integrate effectively.

Table of Contents

API Overview

The Face Scan PPG Data Delivery system is designed to securely transmit processed health assessment data from HiQOR's AWS environment to your systems. HiQOR acts as the data provider, delivering structured health insights via API to your designated endpoints.

  • Data Delivery: Secure transmission of processed health data to your API endpoints
  • Structured Insights: HiQOR processes and delivers organized health assessment results
  • Flexible Integration: Support for API callbacks or SNS subscriptions
  • Authentication: HiQOR authenticates to your systems using your preferred authentication method

API Endpoints

You will need to provide HiQOR with your API endpoint URL(s) where processed data should be delivered:

https://your-domain.com/api/hiqor/webhook

Your endpoint should be able to accept POST requests with JSON payloads containing the processed health assessment data.

Webhook Endpoints

You will need to provide HiQOR with your webhook endpoint URL(s) where processed data should be delivered:

https://your-domain.com/api/hiqor/webhook

Your endpoint should be able to accept POST requests with JSON payloads containing the processed health assessment data.

Authentication

HiQOR will authenticate to your systems when delivering data. We support various authentication methods and will align with your existing authentication requirements. See the Authentication section for more details on supported authentication methods and how to configure them.

Retry Logic

To ensure reliable data delivery, HiQOR implements automatic retry logic for failed API deliveries:

  • Initial delivery attempt upon data processing completion
  • Up to 3 retry attempts with exponential backoff (1 min, 5 min, 15 min)
  • Failed deliveries are logged and can be manually retried or retrieved via API

Your API endpoint should respond with a 2xx status code to acknowledge successful receipt. Any other response will trigger a retry.

Error Handling

Your API endpoint should return appropriate HTTP status codes to indicate the result of data receipt:

  • 2xx range indicates successful receipt and processing
  • 4xx range indicates a client error (invalid data format, authentication failure, etc.)
  • 5xx range indicates a server error on your end (temporary unavailability, processing error, etc.)

Common response codes your endpoint should use:

200 OK - Data received and processed successfully
400 Bad Request - Invalid data format or missing required fields
401 Unauthorized - Authentication failed
500 Internal Server Error - Temporary server error, will retry
503 Service Unavailable - Endpoint temporarily unavailable, will retry

Getting Help

If you encounter any issues, have questions about API setup, or need to configure authentication, please don't hesitate to contact our development team at api@hiqor.com.