Differences

This shows you the differences between two versions of the page.

--- newdevs:apis [2023/01/19 09:12] – tmccanna
+++ newdevs:apis [2024/01/17 16:06] (current) – [Things to add to this page:] tmccanna
@@ Line 4: / Line 4: @@
 ===== Examples of Using Specific APIs =====
+==== Get an Auth Token ====
+An Auth Token is needed for many of the other API calls.
+<nowiki>https://<domain>/osrf-gateway-v1?service=open-ils.auth&method=open-ils.auth.login&param={"username":"<user name>","password":"<password>"}</nowiki>
 ==== Carousel API ====
-Retrieve carousel IDs by passing an org ID:\\
+Retrieve carousel IDs by passing an org ID:
-https://gapines.org/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.retrieve_by_org&param=9
-Retrieve contents of a carousel by passing a carousel ID:\\
+<nowiki>https://<domain>/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.retrieve_by_org&param=<org id></nowiki>
-https://gapines.org/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.get_contents&param=194
+Retrieve contents of a carousel by passing a carousel ID:
+<nowiki>https://<domain>/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.get_contents&param=<carousel id></nowiki>
 ===== Things to add to this page: =====
@@ Line 19: / Line 27: @@
   * Link to Galen's Evergreen Conference presentation
   * Description of each of the established APIs and how to call them
-  * How to get contents of a carousel by passing it the carousel ID: https://gapines.org/osrf-gateway-v1?service=open-ils.actor&method=open-ils.actor.carousel.get_contents&param=194
+  * Specs currently under review for RESTful API work - https://yeti.equinoxoli.org/dev/public/techspecs/restful_api_spec_202312.pdf