Preferred Method: API Endpoint
Our preferred delivery method is a standard REST API Endpoint. This allows our ingestion engine to poll for updates on a scheduled basis.- Authentication: We support standard, lightweight authentication methods including Basic Auth, API Keys, or Bearer Tokens.
- Access Requirements: To minimize the risk of service interruptions, we require an endpoint that does not require IP whitelisting. We utilize a distributed cloud-based ingestion system; therefore, open access (secured by auth) is mandatory for a stable connection.
- Payload Structure: A “One-Request” model is preferred. All metadata for a specific title—including descriptions, artwork, and availabilities—should be contained within a single response.
Alternative: File Download (Server or S3)
If an API is not available, TitanOS can download a static export from your server or a cloud storage provider (e.g., Amazon S3).- Consistency: If hosting a file on your own server, the filename must remain consistent to ensure our automated crawler can locate the file during every sync cycle.
- Format: We support both JSON and XML. However, JSON is strongly preferred for its efficiency and ease of mapping.
- Timeline Impact: Implementing a file-based or bucket-based workflow requires additional custom configuration and may extend the overall integration timeline.