Using the API

Why this exists

Copying enquiries and lesson details between your website and other systems by hand wastes time and invites mistakes. The API lets those systems read your centre's data and send in new enquiries directly, with keys that can do only what you tick. It is for whoever looks after your website or other systems.

The API lets your website or another system read your centre's data, such as campuses, services, lessons and the roll, and send in new enquiries. It is for whoever looks after your website or other systems.

Before you start

• You need integrations.manage and two-step sign-in.
• The API must be switched on for your centre by the platform. Until it is, API keys does not appear under Settings > Connections, and the page says it is not switched on yet. Ask your centre's admin to request it.

Make a key

1. Go to Settings > Connections > API keys and choose Make a key.
2. Give it a name so you can tell your keys apart.
3. Under What this key may do, tick only what the system needs. Read only ticks every read permission except enquiry contact details, and Website enquiry form ticks sending enquiries plus reading campuses, services and subjects. You can read campuses, services, subjects, tutors, families, students, lessons, the roll, invoices and enquiries, and send enquiries. Tags, staff tasks, the waitlist, group classes and term progress reviews can be read too, once each of those features is switched on for your centre.
4. If you like, limit it to certain internet addresses, to your website's address for use from a browser, to a number of requests a minute, or to an expiry date.
5. Press Make the key, then Copy the key. It is shown only once.

Give the key to your developer. How the API works on the same page, and Read the guide, list every endpoint and the permission it needs, with an example to try. The full description is at /api/v1/openapi.json on your centre's address.

What the API can and cannot do

• It can read your centre's data and create an enquiry. It cannot change or delete anything else: lessons, the roll, families and money are changed in the portal only.
• An enquiry sent through the API is checked like one from your enrolment form, but no email or text goes to anyone. Your admins get the usual notice in the app.
• An enquiry's parent name, email and phone are returned only to a key with Enquiry contact details ticked, which no preset ticks. Tick it only for a system you trust with them.
• It never gives out home addresses or notes, safety records, AI conversations, custom field values, a child's own contact details, lesson notes, meeting links or payment details.
• A key covers the whole centre. It cannot be limited to one campus.

Looking after keys

• Your keys shows each key, what it can do and when it was last used.
• Revoke a key the moment it is no longer needed or may have leaked. It stops working straight away.
• Every key made or revoked is recorded in the audit log.

Related

• Sending events to other apps with webhooks
• Connecting your services