Skip to content

Integrations · Developers

A REST API to connect your own systems

Connect your website, a data warehouse or another tool. The API goes through the same rules as the app itself, so a key can never see or change more than a member of staff with the same access could.

What it does in Affinux

  • What it covers

    • People and organisations, and their relationships, to read and write.
    • Tasks and opportunities.
    • Invoices with their lines and payments.
    • Gifts and Gift Aid declarations, so years of giving history can be brought across from another system.
    • Programmes, places and attendance, to read.
    • Branches.
    • A feed of deleted records, so a copy elsewhere can remove what was erased here.
  • Keys and access

    • Service accounts, each with its own keys and scopes, finer than the app’s own permissions.
    • Keys revoked at once, and marked when they are handed to an outside organisation, so people who asked not to have their details shared are left out.
    • A dry run for any write, reporting what would happen without changing anything.
  • For developers

    • Public documentation, an OpenAPI description and a dated changelog at `https://app.affinux.com/developers`.
    • A playground in the settings that runs real requests with a key made for it.
    • A log of the organisation’s requests for 30 days, and monthly usage.

Set it up in three steps

  1. Make a service account

    Give it its own keys and scopes, finer than the app’s own permissions.

  2. Try it in the playground

    The playground in the settings runs real requests with a key made for it.

  3. Dry-run your first write

    A dry run reports what would happen without changing anything.

Control and safety

  • Every request runs through each area’s own permissions, branch rules and hidden fields, and writes its audit trail like a change in the app.
  • Request limits per key and per organisation.
  • Keys are stored only as hashes, and the request log keeps no bodies and no search values.
  • Switching the API off stops every key, with the number of live keys shown first.

Good to know

  • Contracts, the price list, training, consent and grants are not in the API yet.
  • There are no outgoing webhooks; systems read changes from the API.
  • Another system can start an automation by calling its private web address, and an automation step can call another system’s address.

Questions about the API

Which records can the API read and write?

People and organisations with their relationships, tasks and opportunities, invoices with their lines and payments, and gifts and Gift Aid declarations. Programmes, places and attendance can be read. Contracts, the price list, training, consent and grants are not in the API yet.

Are there webhooks?

There are no outgoing webhooks: systems read changes from the API. Another system can start an automation by calling its private web address, and an automation step can call another system’s address.

Where is the documentation?

Public documentation, an OpenAPI description and a dated changelog are at app.affinux.com/developers.

See how Affinux would work for your team

A 30-minute demo, shown with your type of organisation. Or start a free trial and explore with sample data.