Get started
Try it and collections
The API reference is an interactive page generated from the same OpenAPI file that defines the contract. You can read every operation there and send test requests from the page.
The console is for the test environment only
- The page lists one server: the Librarika test API. Production is not in the list, so the console cannot be pointed at it from the page.
- Paste a test API key only. A production key sent to the test environment fails with
401 invalid_token; the API does not say why. - The page loads everything from its own address: the reference script is served with the site, with a Subresource Integrity hash, and the page has no third-party font, analytics or proxy. Requests from the console go to the test API and nowhere else.
- The key lives in the page's memory for the tab. It is not written to cookies,
localStorageor the address. Close the tab, or reload, to forget it. - Test data is fixture data (the library
alpha); nothing in it is real.
Sign-in with OAuth (not in the console yet)
Member sign-in (authorization code with PKCE, and a DPoP proof on every call) is not available in the console yet: the console takes an API key. To try the member flows, follow DPoP and Tokens with your own client against the test environment.
Collections
Import the collection and its environment into Postman:
The environment has two variables: baseUrl, the test API, and apiKey, empty and marked secret. Fill apiKey with a test key in your own copy; the collection sends it as a Bearer token on every request.
Bruno and Insomnia import the OpenAPI file directly (Bruno: Import collection, OpenAPI; Insomnia: Import, from file). Set the base URL to the test API and the token to a test key.
The same file also works as input for generators such as openapi-generator. Version 1 publishes no SDKs; integrators generate their own.
Regenerating
The collection is generated from the committed spec, never written by hand: make collections rewrites it and make collections-check fails when it is out of date.