.png)
Dynamic Yield Integration Guide
Connect Dynamic Yield personalization, catalog, campaign, and behavioral data capabilities with enterprise systems through REST APIs, feeds, events, and controlled workflows.
Dynamic Yield integration options at a glance
Dynamic Yield primarily integrates through REST APIs for platform administration, catalogs, personalization, events, and related data operations. Catalog feeds and structured file exchange may support CSV, XML, or JSON depending on the tenant configuration. Behavioral events can be submitted from commerce platforms, applications, or customer data pipelines, while webhook-style callbacks may be available for selected features rather than universally. Dynamic Yield uses API credentials or API keys for server-to-server access. Martini can consume these APIs, retrieve and validate feeds, map catalog and event payloads, schedule batch synchronization, expose APIs for storefronts, and apply retries, deduplication, and business rules around each integration.
Common Dynamic Yield integration patterns
Common Dynamic Yield data objects used in integrations
Authentication and security considerations
API credentials and environment context
Dynamic Yield server-to-server APIs generally use tenant- or environment-specific API keys or credentials. Requests may also require account, site, section, environment, or deployment context, with permissions determined by the credential and operation.
Secrets and identity protection
Store Dynamic Yield credentials in Martini secrets or protected environment configuration. Do not expose server-side API keys in browser code or client-facing API responses, and use separate credentials for environments where available.
Visitor and privacy controls
Visitor identifiers, customer identifiers, device identifiers, and session context should be mapped deliberately. Apply consent, regional privacy, data-retention, and data-minimization rules before forwarding behavioral events.
- Validate inbound requests and callback payloads before processing.
- Limit credentials to the Dynamic Yield operations required by each workflow.
- Keep vendor credentials separate from visitor or customer identifiers.
Operational considerations for Dynamic Yield integrations
Rate limits and retries
Confirm limits for each Dynamic Yield API. Use controlled retries with backoff and jitter for throttling and transient 5xx responses, and prefer catalog feeds or batch mechanisms for large updates when supported.
Pagination and checkpoints
Implement endpoint-specific pagination and persist page, continuation, last-processed identifier, or other checkpoint data where applicable. Do not assume that every Dynamic Yield endpoint uses the same pagination or incremental-sync model.
Idempotency and schema changes
Use stable event or transaction identifiers where available, maintain a processing ledger for replay-sensitive events, and key catalog updates by stable product identifiers. Validate required fields and monitor changes to event, catalog, campaign, audience, and recommendation schemas.
Testing and observability
- Test visitor identity, consent filtering, catalog quality, campaign timing, and recommendation fallbacks in non-production environments.
- Capture HTTP status, request identifiers, source IDs, response bodies, and Martini workflow execution IDs.
- Separate rejected records from retryable vendor or network failures.
- Monitor event acceptance, catalog rejection, response latency, and recommendation availability.
Why use Martini instead of scripts or point-to-point integrations?
Reusable orchestration
Martini coordinates Dynamic Yield API calls, catalog feeds, event forwarding, downstream writes, and callback handling in workflows that can be reused across channels and environments.
Controlled transformation
Mappings, validation, privacy filtering, identity normalization, business rules, and fallback behavior are kept explicit rather than scattered across scripts or point-to-point implementations.
Operational resilience
Martini provides a place to implement scheduling, pagination, checkpoints, retries, error routing, monitoring, and replay controls around Dynamic Yield’s tenant-specific APIs and feed mechanisms.
Stable internal APIs
Martini can expose APIs that shield storefronts and internal applications from vendor credentials and changing vendor payloads while combining Dynamic Yield results with enterprise data such as pricing, inventory, or customer context.