Onboarding Checklist
This checklist provides a complete guide for onboarding and API integration. Ensure all steps are completed before moving to production.
description: "This checklist provides a complete guide for onboarding and API integration. Ensure all steps are completed before moving to production."
Onboarding Checklist
Prerequisites & Access Setup
Required Access
Namespace access is managed at the team level. To request access, provide the namespace and environment details (for example, EU3_retailerco) to the Epsilon Support team.
☐
Ensure you have membership in the correct supplier or primary retailer team. Access to the appropriate team is required to generate the API token.
☐
API intake request submitted (KB0040933).
☐
Reporting API (BigQuery) access requested if needed.
☐
User Key retrieved from profile settings.
☐
Base URL obtained from Support team.
☐
Environment Setup
Sandbox environment API URL confirmed. (Contact the Service Desk to confirm the correct sandbox domain for your account).
☐
Environment URLs confirmed. (Contact the Service Desk to confirm the correct environment domain for your account).
☐
Required metadata (product catalog, placement, team information) is verified by either: - Raising a ticket with the Service Desk, or - Accessing BigQuery tables: dim_product, dim_catalog, and dim_placement.
☐
Authentication & Core Integration
Authentication Setup
User Key Authentication token implemented.
☐
Access token retrieval working (24-hour expiry).
☐
Authentication headers configured correctly.
☐
Sandbox authentication tested.
☐
Core API Integration
Campaign Management endpoints integrated.
☐
Team & User Management endpoints integrated.
☐
Wallet Management endpoints integrated.
☐
Content Standard endpoints integrated.
☐
Bulk Operation API endpoints configured.
☐
Data Format Validation
JSON payload structures validated.
☐
Required field mappings completed.
☐
Campaign field definitions understood.
☐
Creative asset requirements verified (< 4MB, PNG/JPEG/JPG/GIF/SVG/PDF).
☐
ISO-8601 timestamp format implemented.
☐
Campaign & Feature Testing
Campaign Testing
Sponsored Product Ads (SPA) creation tested.
☐
Banner campaign creation tested.
☐
Banner X campaign creation tested.
☐
Campaign approval state changes tested (required only for Retailer integrations; not applicable for Suppliers).
☐
Bulk campaign operations tested (optional, based on the use case).
☐
Wallet & Team Testing
Wallet creation and management tested.
☐
Fund management operations tested.
☐
Team creation and user invitation tested.
☐
User permission modifications tested.
☐
Spend calculation endpoints tested.
☐
File & Asset Testing
Creative asset uploads tested.
☐
File size and format validation working.
☐
Content standard retrieval tested.
☐
Logo uploads for teams/users tested.
☐
Best Practices Implementation
Bulk endpoints used for multiple operations.
☐
Compressed files implemented for uploads.
☐
Error handling with structured JSON responses.
☐
Field validation before request submission.
☐
Monitoring & Support
API call monitoring implemented.
☐
Error logging and alerting configured.
☐
Performance metrics tracking setup.
☐
Support contact information documented.
☐
Escalation procedures established.
☐
Requirements Checklist
Must-Have Before Go-Live
User Key Authentication working in production.
☐
Campaign creation (SPA/Banner/Banner X) functional.
☐
Creative asset uploads working (< 4MB limit).
☐
Error handling for all HTTP status codes.
☐
Bulk operations tested for efficiency.
☐
Content standards and placements validated (including PDF component verification).
☐
API-Specific Validations
Namespace access confirmed.
☐
Team membership and permissions verified.
☐
Required metadata (catalog, placement) available.
☐
BigQuery access for reporting (if needed).
☐
File format validation (PNG, JPEG, JPG, GIF, SVG, PDF).
☐
ISO-8601 timestamp format compliance.
☐