The FlexAdvisor API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
You can use the FlexAdvisor API in test mode, which does not affect your live data or interact with the existing academic platforms and networks.
The FlexAdvisor API differs for every account as we release new versions and tailor functionality. Log in to see docs customized to your version of the API, with your test key and data.
In order to enable the backend, clone this repository and open with Visual Studio Code. Open a new terminal with the directory path set to the new repository.
install npm -g install express -g install mongoose -g install express -g
Edit the ATLAS_URI in ".env" file. set it = to your mongodb atlas conection string.
Install Insonmia for headless API testing https://insomnia.rest/
GitHub should automatically version any commit changes.
- Mongoose - MongoDB connectivity
- React - The web framework used
- Express - Node.js web framework
- Node.js - js runtime script engine
(apiary.apib) design modules for mock implementation included.
Check reference API documentation (apiary.apib) on how to access/retrieve data using our API's
:)