Documentation Index

Fetch the complete documentation index at: https://help.elaine.io/llms.txt

Use this file to discover all available pages before exploring further.

Integration overview and interface selection

Prev Next

Elaine provides multiple integration interfaces for different operating models: RESTful APIs, the function-oriented HTTP API, the Form API, and SIEIS for secure file exchange. The best choice depends on latency, volume, interaction pattern, and operational ownership.

Interface decision matrix

                                                                                                                                                                                                     
InterfaceBest fitProcessing modelVolume and latency profileChoose it when
RESTful APIsModern system-to-system integration, transactional operations, and selected resource-oriented workflowsSynchronous request and response, with asynchronous processing where the operation requires itLow-latency individual operations through high-throughput API workloadsThe calling system needs immediate technical feedback and a modern integration contract.
HTTP APIBroad access to Elaine functions, existing integrations, single calls, and bundled function callsSynchronous single or bulk requests; some functions use optimized bulk processingFine-grained real-time calls through larger bundled workloadsYou need a specific Elaine function or want to reduce request overhead by bundling calls.
Form APIRegistration, subscription, unsubscription, and other web-form submissionsSubmission-oriented processing from a website into ElaineInteractive web requests with immediate visitor flowA website should submit form data to Elaine without implementing a broader data integration.
SIEISLarge contact imports, campaign data, content data, and scheduled exportsAsynchronous file exchange over SFTPLarge batches and recurring high-volume exchangeData can be bundled into files and throughput, restartability, and operational control matter more than per-record response time.

Choose by workload

     
  • One business event or message now: use a RESTful or HTTP-based transactional interface.
  •  
  • Many similar operations in a short period: use supported API bulk processing or an asynchronous submission pattern.
  •  
  • A visitor submits a web form: use the Form API when its submission model covers the required workflow.
  •  
  • Hundreds of thousands or millions of records in a planned exchange: use SIEIS or a purpose-built high-throughput API flow.
  •  
  • A source system emits business events without waiting for the complete downstream process: use event-based integration.
  •  
  • An external campaign or backend platform should control complete engagement workflows: combine APIs, events, transactional messaging, and batch exchange in a headless operating model.

Scale from real time to large batches

Elaine integration patterns cover individual low-latency transactions as well as large batch operations. With the appropriate interface, payload design, concurrency, and contracted capacity, deployments can process up to millions of records or messages per hour.

 

Capacity note: Achievable latency and throughput depend on the selected operation, payload size, personalization and rendering complexity, concurrency, environment configuration, and agreed service capacity. Confirm performance targets during solution design and load testing.

Optional site-to-site VPN

Transport encryption is required independently of network topology. Where an additional private network boundary is needed, selected Elaine interfaces can optionally be connected through a persistent site-to-site VPN. VPN availability depends on the service and operating model; not every public-facing endpoint is routed through a VPN.