SDK Patterns

Overview

DMTR provides SDK patterns and libraries for building integrations across research platforms, portfolio systems, and enterprise data sources. These patterns standardize authentication, data sync, event handling, and error handling. Use the SDKs to reduce boilerplate and ensure consistency with DMTR best practices.

Authentication

Integrations authenticate via OAuth 2.0 or API keys depending on the use case. OAuth is required for user-delegated access (e.g., extension flows); API keys are used for server-to-server integrations. Credentials are scoped by permission; rotate secrets according to the secrets rotation lifecycle. Never expose credentials in client-side code.

Data sync patterns

Data sync supports batch and real-time patterns. Batch sync is used for initial loads and periodic reconciliation; use the bulk APIs with pagination. Real-time sync uses webhooks for position updates, transfer events, and lifecycle changes. Choose the pattern based on latency requirements and data volume. Idempotency keys are required for write operations.

Event handling

Integrations receive events via webhooks for position lifecycle, transfer status, and registry updates. Implement idempotent handlers and acknowledge events promptly to avoid retries. Use the event payload schema to parse and route events. Failed deliveries are retried with exponential backoff; implement dead-letter handling for persistent failures.

Error handling

Handle API errors using standard HTTP status codes and the DMTR error response format. Implement retry logic with exponential backoff for transient errors (429, 503). Do not retry client errors (4xx) except for specific cases like rate limits. Log errors with request IDs for support; surface user-friendly messages for end users.