...
This document contains description of the GitHub repositories related to APIs. All active GitHub repositories of the EWP Network are documented on a separate page:
...
The document starts with the description of the API management cycle and rules of the API design and versioning.
...
Once the APIs are developed and tested, in compliance with the regulations of the EWP network (see Joining the EWP entry procedureNetwork and Technical testing and validation sitereports), they can be deployed in the production network. This deployment stage involves coordinating the process, setting up monitoring and logging, and checking the APIs in the target environment to ensure everything is running smoothly.
...
Business goals change, new priorities arise, requirements get reformulated or change priority, technical needs may require change in the network architecture. For such reasons, an API may reach the end of its useful life and needs to be retired. There is a well-defined process in place to ensure a smooth and orderly transition, which includes decommissioning an API, removing all dependencies, and notifying transition plans to API users.
| Info |
|---|
According to the currently agreed rule, upgrades of the existing APIs taking into account new requirements should not happen more often than once a year. |
...
Rules of API design and versioning
...
Institutions and faculties
Institutions APIallows external clients to retrieve general information on institutions either covered, or otherwise known, by the host. This information includes things like address, logo image and key contact persons.
Organizational Units API allows external clients to retrieve general information on selected organizational units (faculties, departments, divisions, etc.) either covered, or otherwise known by the host. It responds with a similar type of information as Institutions API does, but on a lower level.
Courses
Courses API allows other HEIs to access information on courses and other learning opportunities conducted in a given HEI.
Simple Course Replication API allows the clients to replicate the catalogue of courses conducted on this HEI. This in turn allows the clients to design rich course searching user experience.
...