This document outlines the full integration lifecycle — from initial review to production launch — so teams know what to expect, who needs to be involved, and how to stay aligned throughout.
Reach provides:
- API Specification (Swagger / OpenAPI)
- Getting Started Guide
- Responsibilities & Overview documents
Partner reviews the documentation to confirm technical fit and resourcing.
Output: Partner confirms readiness to implement the integration.
Partner builds API endpoints using the Reach API spec:
- Can use any language or framework
- Must secure endpoints using supported authentication (e.g., token-based)
- Endpoints should return accurate, current data in the expected format
Output: API is hosted, secure, and ready for validation.
Partner shares:
- Base URL for the API
- Access token or other credentials
Reach configures access and prepares for syncing.
Output: Reach can connect and authenticate successfully with the partner API.
Reach tests:
- Authentication
- Sync scheduling and stability
- Data display in dashboards and reports
Partner tests:
- Data accuracy and formatting
- Endpoint reliability
Output: A successful test sync, data verified for integrity and accuracy, and confirmation of data visualization in Reach dashboards and reports.
- Enable syncing for live customers (can start with an internal or pilot group)
- Monitor sync jobs and user experience during initial rollout
- Teams stay available for issue resolution
Output: Integration is live and available for real users.
Partner Responsibilities:
- Maintain API uptime and data accuracy
- Inform Reach of any upstream system changes that may affect the API response (e.g., internal schema changes, outages)
- Do not change the structure or behavior of the API without direction from Reach
Reach Responsibilities:
- Maintain and version the API spec
- Notify partners of any changes to the spec or integration requirements
- Monitor data syncing and usage
- Handle support questions related to syncing, reporting, or how data is displayed
Output: A stable, low-maintenance integration governed by a consistent spec.