API

What is an API?

An API (Application Programming Interface) enables third-party applications to interact with Wisenet through a structured interface. It provides access to specific data fields grouped into entities known as Endpoints. Each Endpoint represents a distinct data set and can be called as needed to send or retrieve information.

Wisenet’s Integrated App Platform now leverages OAuth authentication with scopes, replacing the legacy API key approach. This modern solution enhances security, flexibility, and control, ensuring seamless and secure connections between external applications and Wisenet.

How to use the Wisenet API

The Wisenet API is a RESTful web service designed to streamline integration between your third-party applications and Wisenet. By tapping into Wisenet’s workflow automation, the API reduces the need for developers to build complex integrations. Tasks like generating documents, sending emails, or creating tasks are handled automatically, simplifying the development process and boosting efficiency.

Common Use Cases

The Wisenet API offers numerous benefits and can be used in a variety of scenarios, including:

• Data Integration: Send and retrieve data between Wisenet and third-party applications.
  • Populate a membership application.
  • Sync data with an internal employee tracking application.
  • Integrate with a CRM or custom online applications.
• Web Integration: Connect your website to Wisenet or link another application directly with Wisenet.
• Data Updates: Update existing data in Wisenet, such as unit enrolment details, from an external system.

Best Practices for API Usage

• Testing Environment: We recommend using a test environment when developing integrations to ensure accuracy and prevent disruption to live data.
• Licensing Requirements: The API is available only with specific Wisenet licenses. Please contact us for access if needed.

By leveraging Wisenet’s API and its workflow automation capabilities, your organisation can efficiently integrate systems, automate processes, and achieve seamless data management with minimal development effort.

Why OAuth?

OAuth is an industry-standard protocol for authorisation. By adopting OAuth with scopes, Wisenet ensures your integrations are:

• Granular: Scopes define specific access permissions (e.g., course_read, unit_write).
• Secure: OAuth eliminates the need for long-term API keys, reducing security risks.
• Simplified: Tokens can be renewed or revoked without affecting other integrations.

Key Features

• Authorisation Scopes: Define specific access and actions for apps (e.g., course_read, unit_write).
• Token-Based Access: Temporary tokens provide secure access, with defined expiration times.
• Centralised Control (Coming Soon): Manage, monitor, and revoke tokens via Wisenet Connected Apps.
• Improved Logging: Gain visibility into app activity and access with detailed logs.

Transitioning from API Keys to OAuth

1. Register Your App: Complete the App Registration Form.
2. Implement OAuth: Follow the OAuth Authentication Flow in the Developer Documentation.
3. Update Your App: Replace API key logic with token-based requests.

Developer Resources

The updated Developer Documentation includes:

• Sample OAuth requests and responses.
• Step-by-step guides for the authorisation code flow.
• Best practices for managing and securing tokens.

Wisenet API Docs

Wisenet OAuth Docs

FAQs

What happens to existing API key integrations?

API key support will be deprecated by early 2026. Existing integrations will continue to function until then but must migrate to OAuth before deprecation.

How do I know which scopes to assign?

Refer to the Scope Reference Guide for a breakdown of permissions for each scope.

How do I start the transition?

Upgrade your integrations to take advantage of OAuth’s enhanced security and flexibility. Visit the Integrated Apps Setup Guide (Coming Soon) or contact support for assistance.