Skip to main content

Connect software to Abe

Who this is for​

Software owners connecting selected Abe services, and administrators arranging staff access. The general customer-ready integration journey is not yet verified. Existing connection and partner interfaces must be assessed individually; an API existing in the backend does not establish commercial, source or customer permission for every caller.

Start here​

  1. Read API guidance and Developer guidance. Decide which service and audience your software will present. Use Vendor integrations for a specific practice-management product.
  2. Register the exact application origin and return addresses. App registration is pending until accepted; do not infer activation from receiving an application record.
  3. Keep the confidential connection on your server. Users sign in and review their own selected permission; your software must preserve account and context boundaries.
  4. An organisation service key does not identify a person or supply personal consent. Use only the rights actually accepted for that service caller. Workers cannot impersonate a staff member or activate their alert subscription.
  5. Keep read access distinct from an action: a governance read does not generate a policy, create a task or approve an artefact. Extra actions require independently implemented rights and confirmations.
  6. Test scope refusal, expired access, wrong user/business, source unavailability, disconnection and uncertain delivery before releasing the connection. Keep patient information outside these professional-information interfaces.

What success looks like​

A result belongs to the correct person and context, uses current permitted sources and carries the evidence needed to inspect it. Payment funds only the accepted service; it does not create consent, prove clinical eligibility or activate alerts. Your chosen software interface must be witnessed separately from Abe's direct service. A receipt of acceptance is distinct from an unknown outcome; do not report a successful delivery without its actual record.

If it does not work​

Do not bypass an unavailable source, context or permission by switching to an unrestricted endpoint. Use Troubleshooting. For an uncertain delivery or payment, reconcile the original operation before retrying; do not create a second send or charge blindly. Offer direct professional development or evidence access while a specific vendor contract or integration remains unavailable.

Stop or change your choices​

Users disconnect their app in Abe and manage alerts separately. Administrators withdraw only access they are authorised to manage; personal consent and private criteria remain the person's own. Software must recheck current access after disconnect, expiry, employer departure or downgrade. Removing a local token is not proof that Abe permission removal completed. Confirm both sides and keep any uncertain result visible. Cancellation of payment remains separate; see Manage and cancel.