Generate and Manage API Access in openSIS

Generate and Manage API Access in openSIS

Overview

The API Access page allows authorized users to generate API keys for connecting openSIS data with other applications. API keys can be used to read, create, and update school-specific data through supported API endpoints.

This section is mainly used by administrators, technical users, or integration teams who need API-based access to openSIS data.

Info
Menu > Tools > Developers > API Access

Steps to Generate a New API Key

  1. Log in to openSIS with an authorized user account.
  2. Go to the left menu.
  3. Click Tools.
  4. Under Developers, click API Access.
  5. Click Generate New API Key.
  6. In the Generate New API Key modal, enter a Title for the API key.
  7. Click Generate.
  8. The new API key appears on the API Access page.

View an API Key

  1. Go to Menu > Tools > Developers > API Access.
  2. Locate the API key record.
  3. Click the expand arrow on the right side of the API key row.
  4. The API key details will be displayed.
  5. Use the copy icon to copy the API key if needed.

Manage API Key Access

  1. Open the API Access page.
  2. Locate the API key you want to manage.
  3. Click the settings icon beside the key.
  4. The API Keys access configuration page opens.
  5. Review the available modules, such as:
    • School
    • Student
    • Staff
  6. Use the access toggle to enable or disable API access for a module or endpoint.
  7. Expand a module to view available API endpoint details.
  8. Click Update to save the access configuration.

Field and Button Explanation

Field/ButtonDescription
Generate New API KeyOpens the modal to create a new API key.
TitleA required name used to identify the API key.
GenerateCreates the API key after the title is entered.
CancelCloses the modal without creating a key.
API DocsOpens API documentation for setup and usage guidance.
Edit IconAllows the API key details, such as title, to be edited.
Delete IconDeletes the selected API key.
Settings IconOpens the access configuration page for the API key.
Expand ArrowShows or hides the API key details.
Copy IconCopies the API key.
Refresh IconRefreshes or regenerates the API key, if supported.
Access ToggleEnables or disables access for a module or endpoint.
UpdateSaves the API access configuration.

Important Notes

  • API Access should be used only by authorized users.
  • API keys can allow external applications to access openSIS data.
  • Keep API keys secure and do not share them publicly.
  • Delete unused API keys to reduce unnecessary access risk.
  • Enable only the modules or endpoints required for the integration.
  • Review API access settings carefully before clicking Update.
  • Use the API Docs link for technical implementation guidance.

    • Related Articles

    • Understanding Tools & Utilities

      Overview The Tools & Utilities section in openSIS provides administrative tools for managing system-level tasks. These tools help authorized users import data, export records, perform end-of-year rollover, and review system activity. This section is ...

    • View System Access Log

      Overview The System Access Log allows authorized users to review login activity in openSIS. It shows who accessed the system, when the login happened, whether the login was successful or failed, the failure count, and the IP address used for access. ...

    • Export Data from openSIS to Excel

      Overview The Export Data from openSIS to Excel tool allows authorized users to download important openSIS data in Excel format. This is useful when administrators need to review records offline, maintain a backup, share selected information with ...

    • Bulk Import or Update Student Data

      Overview The Bulk Import or Update Student Data tool allows administrators to add multiple student records or update existing student information using an import file. This is useful when a school needs to create student records in bulk or maintain ...

    • View Activity Log

      Overview The Activity Log in openSIS helps authorized users review actions performed inside the system. It records who performed an action, when it was done, the system area involved, and a short description of the activity. This log is useful for ...