Date: Fri, 29 Mar 2024 01:00:42 +0000 (UTC) Message-ID: <1369278737.1.1711674042554@ae8e7c6be9a3> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_0_1360517640.1711674042539" ------=_Part_0_1360517640.1711674042539 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
As you=E2=80=99ll see through the documentation of our HTTP interfaces, = it=E2=80=99s important to ensure you=E2=80=99re hitting an index. Single Te= nant Enterprise users can use the following request to find the available i= ndexes.
GET = http://www.example.org/api/indexes/MODEL_NAME
For example, to find the indexes available for the Statem= ent model, you can use the following request.
GET = https://saas.learninglocker.net/api/indexes/statement
Everything you can do in the UI, can also be done via the API. Open up t= he dev tools in the browser, switch to the Network panel, then do the a= ction you want in the UI and observe the API requests that complete the act= ion in the Network panel.
You may notice that some parts of the API (like adding organisation role= s to users) currently only support user-based authentication rather than cl= ient-based authentication. Should you need to use these APIs right now, you= can actually get a JWT token for the user and use that to authenticate. Lo= ok at the login flow in the network panel, and pay attention to the JWT we = return when you login AND when you access an org. Those are the bearer toke= ns (depending on whether you are at the site, or org level). See Administrator level authentication flow= for more information.
Below are details of the Postman Collections and Environment that you ca= n use.
Below are some of the Postman Collections= we use internally to test and demonstrate Learning Locker=E2=80=99s A= PIs.
You can import a collection file. Click on the =E2=80=98Import=E2=80=99 = button on the top bar, and paste a URL (use the links above) to the collect= ion, or the collection JSON itself, and click =E2=80=98Import=E2=80=99.
We recommend that you use a Postman Environm= ent to utilise our collections. Each of your environments need the= variables below.
auth
version
baseUrl
iri
mbox
id
To get started please create a new Postman Enviroment, then modify your =
environment and select =E2=80=9CBulk edit=E2=80=9D. Once inside the bulk ed=
it you can copy the code below and paste it into Postman. Please change&nbs=
p;YOUR_AUTH
to your base 64 encoded&nbs=
p;basic auth details (which can be found unde=
r =E2=80=9CManage clients=E2=80=9D on the left, inside an LRS on Learning L=
ocker), and YOUR_ENDPOINT
to your LL endpoint (the o=
rigin).
auth= : YOUR_AUTH version: 1.0.1 baseUrl: YOUR_ENDPOINT iri: http://www.example.com mbox: mailto:ex@mple.com id: fd590b50-cbc3-11e4-8830-0800200c9a66