Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

About an API

An API (Application Programming Interface) is a set of protocols, tools, and definitions that allows different software applications to communicate and interact with each, other enabling one system to access data or functionality from another in a standardised way. It serves as an intermediary that lets developers integrate and interact with external services or platforms. APIs are essential for building software ecosystems, as they allow developers to leverage functionalities of other services without needing to understand their internal workings.

Meshed API

The Meshed API is a robust tool engineered to streamline integration and enhance interoperability. This API empowers building customised solutions that drive efficiency and foster innovation, all while ensuring seamless connectivity within an existing Meshed system.

Key Features

  • Meshed API is a REST API.

  • The API enables integration with the Meshed Higher-Ed 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, submitted using POST endpoints and updated using PUT or PATCH endpoints. To maintain data integrity the API does not support deleting data (DELETE endpoints) within Meshed Platforms.

Example Use Cases

  • Student online application form integration

  • CRM (Customer Relationship Management) integration

  • LMS (Learning Management System) integration

Availability

Access to the API is available to existing clients using either the Meshed Higher-Ed or Meshed RTOManager platform. To obtain access, clients must complete and sign an API Access Request Form. API access is governed by the End User License Agreement (EULA) for the specific Meshed platform the client has signed with Meshed Group, as well as the Terms and Conditions outlined in the API Access Request Form.

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)

  • Campus (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 (external link)

Contact and Support

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

Getting Started

  1. Complete and sign an API Access Request Form

  2. Receive an OAuth2.0 Bearer Token

  3. Access the sandbox environment

  4. Explore the endpoint documentation (external link)

  5. Start developing a custom integration solution

  • No labels