English
English Norsk Dansk

Choose language

English Norsk Dansk

API reference

View as Markdown The page’s .md file llms.txt All pages, for AI tools Open in ChatGPT Ask questions about the page Open in Claude Ask questions about the page

PLAS is not one API but four — and they are not siblings. Two are entry points: Provider is what the library system exposes, Vendor is what the service exposes back. The other two are profiles of Provider that can be implemented on their own — also by a third party.

  • Entry point

    Provider API

    v0.6.7 · In production · 22 groups · 59 operations · 420 schemas

    The interface a library system exposes so that services can work with patrons, loans, reservations, holdings and payment.

    Open Provider API Schema index
    Profiles of Provider API

    • Search API

      v0.6.7 · 8 of the 59 operations in Provider API

      The read side of the catalogue — works, publications, agents and suggestions.

      Open Search API

    • Content API

      v0.6.7 · 4 of the 59 operations in Provider API

      The events a library publishes, with time, place, audiences, price and the series they belong to.

      Open Content API
  • Entry point

    Vendor API

    v0.6.7 · In production · 3 groups · 4 operations · 153 schemas

    The other direction — what the service itself exposes, so the library system can send events and send the patron back after a login.

    Open Vendor API Schema index

All versions and spec files

Every release kept here is the OpenAPI file it shipped with; the oldest releases in the changelog have only the PLAS Status notes. The files are copies of the PLAS team’s own.

  • In production is the newest version the PLAS team has put in production, and the one the site shows by default.
  • In specification is newer than the version in production. The PLAS team has not put it in production, and fields may change.
  • Archive is an older release. Older releases may still be running at providers and keep their own reference pages — the version switcher in the side menu takes you there.

The four APIs are released on the same version number.

Provider API

Vendored OpenAPI files by API and version — Provider API
VersionStateUpdatedFile
v0.6.7 In production — provider_v0_6_7.yaml 285 kB
v0.6.6 Archive — provider_v0_6_6.yaml 237 kB
v0.6.5 Archive 9 Dec 2025 provider_v0_6_5.yaml 230 kB
v0.6.4 Archive 9 Dec 2025 provider_v0_6_4.yaml 227 kB
v0.6.3 Archive — provider_v0_6_3.yaml 202 kB

Search API

Vendored OpenAPI files by API and version — Search API
VersionStateUpdatedFile
v0.6.7 In production — search_v0_6_7.yaml 70 kB
v0.6.6 Archive — search_v0_6_6.yaml 68 kB
v0.6.5 Archive — search_v0_6_5.yaml 68 kB
v0.6.4 Archive — search_v0_6_4.yaml 68 kB

Content API

Vendored OpenAPI files by API and version — Content API
VersionStateUpdatedFile
v0.6.7 In production — content_v0_6_7.yaml 32 kB
v0.6.6 Archive — content_v0_6_6.yaml 30 kB
v0.6.5 Archive — content_v0_6_5.yaml 30 kB
v0.6.4 Archive — content_v0_6_4.yaml 30 kB

Vendor API

Vendored OpenAPI files by API and version — Vendor API
VersionStateUpdatedFile
v0.6.7 In production — vendor_v0_6_7.yaml 74 kB
v0.6.6 Archive — vendor_v0_6_6.yaml 73 kB
v0.6.5 Archive — vendor_v0_6_5.yaml 66 kB
v0.6.3 Archive 13 May 2025 vendor_v0_6_3.yaml 64 kB