Gallagher Security API Reference - OAS3 edition

Gallagher Security Technology Partner Program

While you are welcome to read our API documentation, if you are intending to write an integration to the Gallagher Command Centre product utilising any of our integration tools we first require that you onboard as a Gallagher Security Technology Partner.

In order to onboard as a Technology Partner we require that you complete and submit the Gallagher Security Technology Partner Agreement. As a Technology Partner, we'll provide you with all the tools and support you need to create your integration, including:

REST API developer reference manual

This is a tentative port of the authoritative API reference material from OAS version 2 to 3. You have a choice of renderers:

  • OpenAPI Explorer: a navbar and one page per route.

  • Redoc: the closest in appearance to Spectacle, the OAS2 renderer, with a navbar and two columns. One page with everything. Redoc's fatal issue is not rendering the descriptions of schemas included as part of another schema.
  • Redoc static: as above, in one HTML file.

  • Zudoku: renders like Scalar, but has fatal flaws, like not rendering the introductory material.

  • Scalar modern layout. Navbar plus two columns, one page with all sections expandable, collapsed by default.
  • Scalar classic layout: no navigation, just one page with collapsible tags, routes, and models. Excellent search makes up for the absence of navigation.

  • Sourcey default layout. Navbar plus one or two columns depending on context, on one page with all sections expanded, unable to collapse. Sourcey's biggest issues are its handling of 'oneOf' and that following internal links does not add to to the browser history (so the 'back' button does not work as you would expect).
RapiDoc produces very nice results, but the project appears to be dead.