| Info |
|---|
Click here to download an overview document version of this page |
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 acts serves as an intermediary , enabling the integration of various systems by defining the methods and data formats that applications can use to request and exchange informationthat 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. Common uses of APIs include retrieving data from a server, integrating third-party services, and enabling communication between microservices within an application. APIs can be public, allowing external developers to access certain functionalities, or private, intended for internal use within an organization.
APIs offer numerous benefits that enhance the functionality and efficiency of software systems:
...
Integration: APIs allow different software applications to communicate and work together, enabling seamless integration of services and functionalities.
...
Efficiency: By providing predefined protocols and tools, APIs streamline development processes, reducing the time and effort required to implement complex features.
...
Scalability: APIs facilitate the modular design of software, making it easier to scale and add new functionalities without disrupting existing systems.
...
Interoperability: They enable diverse systems and technologies to interact, promoting compatibility and expanding the potential for collaborative solutions.
...
Innovation: By exposing core functionalities, APIs allow developers to build innovative applications and services on top of existing platforms.
...
Security: APIs can enhance security by controlling access to data and services, ensuring that only authorized applications can interact with them.
...
.
...
Enhanced User Experience: APIs enable the integration of third-party services, enriching user experiences by providing more comprehensive and connected solutions.
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.
...
Meshed API is a REST API.
The API enables integration with the Meshed RTOManager and Meshed Higher-Ed 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
Student academic and assessment results integration
Finance and accounting software integration
Availability
Access to the API is available to existing clients using the Meshed Higher-Ed 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 Subject Outcome (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
Complete and sign an API Access Request Form
Receive an OAuth2.0 Bearer Token
Access the sandbox environment
Explore the endpoint documentation (external link)
Start developing a custom integration solution