Skip to content
Last updated

Purpose

This document outlines the division of responsibilities between Reach Reporting and our integration partners. By clearly defining each side’s role, we aim to ensure smooth implementation, reduce back-and-forth, and minimize long-term maintenance.


Partner Responsibilities

Your team is responsible for the following:

Implementing API Endpoints

  • Build and host a small set of endpoints following the Reach Reporting API spec.
  • Expose relevant data (e.g., company metadata, financial metrics) in the expected format.

Maintaining API Availability

  • Keep the API hosted, accessible, and available on a consistent schedule for Reach to consume.

Handling Authentication

  • Secure your API using OAuth 2.0.
  • Reach will authenticate using customer-specific access tokens.

Ensuring Data Accuracy & Freshness

  • Ensure the data exposed is current, accurate, and aligned with what customers expect to see.

Reach Responsibilities

Reach Reporting is responsible for:

Providing a Clear API Specification

  • Maintain a stable, well-documented API spec to guide your implementation.

Connecting Securely to Your API

  • Handle authentication, schedule data syncs, and manage error recovery.

Transforming & Displaying the Data

  • Once data is fetched, map it into our system and make it available in reports, dashboards, and exports.

Monitoring & Support

  • Monitor sync jobs and flag errors.
  • Contact you with relevant context if issues arise for resolution.

Shared Responsibilities

AreaNotes
TestingBoth parties validate the integration before go-live. The partner ensures the API returns accurate data, while Reach verifies that data is syncing correctly and appears as expected in reports.
Customer Support AlignmentSupport responsibilities depend on the issue:
• Data-related (incorrect/outdated data): Partner investigates and corrects API data.
• Sync-related (data not appearing or refreshing): Reach resolves.
• Reporting/display behavior (how a value is shown or charted): Reach supports the customer directly.
Change CommunicationBoth teams commit to timely communication about changes to data models, APIs, or authentication requirements.