Skip to main content

External Partner Integration Guide

Use the External App API to connect a partner application to KINDOO, discover the sites and entry points shared with it, and issue remote commands.

Before you begin

You need:

  • An external app session token supplied during partner onboarding
  • A pairing code created for the customer connection
  • A backend service that can keep the session token confidential

All requests use the production base URL:

https://api.kindoo.tech/ExternalApp/v1

Send the external app session token in the SessionTokenID header on every request. Do not expose this token in browser or mobile application code.

Integration lifecycle

  1. Validate the pairing code to authorize the relationship.
  2. Retrieve linked sites and persist the selected site IDs.
  3. Retrieve linked entry points for each site.
  4. Check CanIssueRemoteCommand before presenting remote access controls.
  5. Generate a remote command and retain its CommandID.
  6. Poll the command status until it reaches a terminal state or your timeout expires.

See the integration flow for the complete request sequence, or open the External App API reference for request and response schemas.

note

Pairing establishes the integration relationship. Your application should still refresh linked sites and entry points so changes made in KINDOO are reflected locally.