This guide explains how to set up and manage API access in SchoolsBuddy after it has been enabled by the Support team. This process allows your technical team to authenticate via OAuth 2.0 and begin connecting your external systems to SchoolsBuddy.

Accessing these settings requires specific permissions; ensure you are logged in as an Organisation Super Admin before proceeding.

Overview

Once activated, the Public API Manager area becomes available for Organisation Super Admins to manage. This central hub is where you will create, edit, and secure the clients used for your school's data integrations.

Key Concepts

Before you begin the setup, confirm that the following prerequisites are met:

• You have already requested API access via support@schoolsbuddy.com
• The SchoolsBuddy team has confirmed that the Public API Manager is enabled for your site.
• You are logged in as an Organisation Super Admin.
• You have your technical documentation ready to configure the necessary permissions and scopes.

Step-by-Step Navigation

Tips & Best Practices

• Staging Environment: Always test your integration in a staging environment if available before connecting to your live SchoolsBuddy instance.
• Bulk Operations: Review the technical documentation thoroughly before initiating bulk write operations to ensure data integrity.
• Credential Maintenance: Within the API Manager, you can edit permissions, regenerate credentials, or disable/delete clients to maintain security.

Warnings & Important Notes

Security Access: API credentials provide significant access to your school's data. Ensure only authorized personnel have Super Admin access to manage these settings.

Public Sharing: Never share your Client Secret publicly; these credentials are uniquely tied to your SchoolsBuddy instance and provide direct access to your data ecosystem.

Related Articles

• Introduction to the SchoolsBuddy Public API

Frequently Asked Questions

What happens if I lose my Client Secret?

For security reasons, SchoolsBuddy may not display the secret again. You will need to use the API Manager to Regenerate Credentials for that client.

Can I limit what the API can do?

Yes. During configuration, you can define specific permissions and scopes to grant only the necessary read (GET) or write (POST/PUT) access required for that specific integration.

In Summary

• Access the API Manager via Settings API Manager.
• Generate credentials by creating a new client with specific scopes.
• Store Client IDs and Secrets securely and never share them publicly.

Your SchoolsBuddy integration is now ready to begin syncing data.