newdevs:apis
Table of Contents
New Developers Working Group
Calling APIs
Examples of Using Specific APIs
Get an Auth Token
An Auth Token is needed for many of the other API calls.
https://<domain>/osrf-gateway-v1?service=open-ils.auth&method=open-ils.auth.login¶m={"username":"<user name>","password":"<password>"}
Carousel API
Retrieve carousel IDs by passing an org ID:
https://<domain>/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.retrieve_by_org¶m=<org id>
Retrieve contents of a carousel by passing a carousel ID:
https://<domain>/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.get_contents¶m=<carousel id>
Things to add to this page:
- Link to Galen's Evergreen Conference presentation
- Description of each of the established APIs and how to call them
- Specs currently under review for RESTful API work - https://yeti.equinoxoli.org/dev/public/techspecs/restful_api_spec_202312.pdf
newdevs/apis.txt · Last modified: 2024/01/17 16:06 by tmccanna