Versions Compared

Old Version 12

changes.mady.by.user Andrew Aylesbury

Saved on

compared with

New Version 13

changes.mady.by.user Andrew Aylesbury

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Meshed API is a REST API.

  • The API enables integration with the Meshed RTOManager and Meshed Higher-Ed Meshed and Meshed RTOManager platforms.

  • The Client team is responsible for designing, developing, verifying, and documenting custom integration solutions using the API, ensuring that their specific business requirements are fully addressed.

  • A sandbox environment that simulates the behavior of the production API is available for developers to explore its features. Access is provided free of charge for one month upon request.

  • Data can be retrieved from Meshed Platforms via GET endpoints and , submitted using POST endpoints and updated using PUT or PATCH endpoints. To maintain data integrity , the Meshed API does not support modifying (PUT endpoints) or deleting data (DELETE endpoints) data within Meshed Platforms.

Example Use Cases

  • Student online application form integration

  • CRM (Customer Relationship Management) integration

  • LMS (Learning Management System) integration

Authentication

The Meshed API uses the OAuth2.0 Bearer Token, enabling secure, token-based access.

Key Endpoints Overview

Multiple endpoints within the API enable interaction with the diverse resources and functionalities of the Meshed Platform. Key endpoints are:

  • Agent (GET, POST)

  • Student academic and assessment results integrationCampus (GET)

  • Classification (GET)

  • Course (GET)

  • Intake (GET)

  • Offer (GET, POST)

  • Student (GET, POST)

  • Student Results (GET, PATCH)

Error Handling

The API uses standard HTTP response codes, a predefined set of status codes that indicate the result of an HTTP request, categorizing outcomes as informational, successful, redirectional, client errors, or server errors.

Versioning and Deprecation

The API is versioned to accommodate future enhancements while ensuring backward compatibility. URI versioning is employed, incorporating the version number directly into the URL path (e.g., /api/v2/Agent). Documentation for each API version is maintained, and any deprecation of older versions will be communicated to Clients. The current version is v1.

Full API documentation

Full API technical documentation is available: https://apisandbox.meshed.online/api-docs/index.html

Contact and Support

Contact Meshed Group via email at support@meshedgroup.com.au for support.