Loading...

Technical Update & API Changes Q1, 2025

1

Endpoint Changes

Credential Endpoints

  • The following fields will be removed from the data model:
    • qReportNumber
    • qReportName
    • documentId (this field has been moved to a relationship)
    • exportDate
  • New relationships have been added for Qualifications.

Unit Endpoints

  • CourseId will be set to null and will eventually be removed.
  • The connection between units and courses will now be established through the CourseUnit relationship instead of the CourseId field.

 

Link to API documentation: https://api-docs.wisenet.co/iae/index.html

2

Authentication Changes

Authentication is transitioning from token-based to OAuth-based authentication.

The primary reason for this change is enhanced security.

Benefits of the New Approach

  • Granular permission granting for more controlled access.
  • Expiring authentication to reduce long-term exposure risks.
  • Revocable access, allowing credentials to be disabled when needed.
  • Two-factor authentication (2FA) for added security.

 

Link to API documentation: https://api-docs.wisenet.co/iae/oauth/index.html?v=1

The token-based authentication approach will be retired in Q4 2025.

3

Scope based permissions

With the change to the OAuth platform, endpoint access will now be controlled by granular Read/Write scopes.

Read scopes will grant access to GET and GETBYID methods (where available).

Write scopes will grant access to POST, PUT, and PATCH methods (where available).

Scope provision can be required or optional, depending on the use case:

  • If your integration has two levels, you may request a required set of permissions for base functionality.
  • An optional set of permissions can be requested for extended functionality.

4

New Endpoints

New endpoints we have released are:

  1. Qualifications
  2. Assessment Submissions
  3. Custom Fields

5

Webhooks

Webhooks are a powerful tool that help you avoid polling for changes, reducing unnecessary calls and improving both cost efficiency and performance in your solution.

Webhooks will be triggered by events in Wisenet.

Supported events include:

  • Entity creation, updates, and deletions.
  • Learncycle events.

Conditional logic can be applied to triggers to allow them to be selectively actioned.

The webhook body will contain minimal information, as it will be sent to a public API endpoint.

Learn more:

  1. How to set up Wisenet Webhooks
  2. Wisenet Webhooks developer resources