> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/integrating-with-xibo.md). # Integrating with Xibo Integrating applications opens the door to many exciting possibilities, and we’ve designed the Xibo CMS from first principles with maximum support for integration. The heart of the CMS is an API which is used by Xibo’s own user interface, and can also be accessed via a 3rd party! The CMS API is used to pull data from the Xibo CMS into another system, or push data from another system into the CMS. Our API makes exciting opportunities to integrate Xibo with other systems possible! For example, imagine an integration with a point of sale system which pushed complimentary products to the signage when a customer purchased something. The CMS API is a RESTful API protected by oAuth. It can be consumed at `//yoururl/api` and exposes routes for all CMS operations. The API is [OpenAPI Compliant](http://swagger.io/) and the documentation is presented using Swagger-UI. Every Xibo CMS install has a `/swagger.json` end point which can be used to provide an API document specific to the version of Xibo running. > The API document in this manual is always for the latest release. [View the API documentation](https://xibo.org.uk/manual/api/). **Older versions** The explore bar at the top of the Swagger documentation can be used to load the API docs from older releases. * 3.3: * 2.3: * 1.8: **Postman** You can copy/paste the `swagger.json` from the above links into Postman’s import function.
Can’t find an API route you need? Xibo has a comprehensive system for customisation and the API is no exception. You can use custom Middleware, Routes and Controllers to implement your own API endpoints to do whatever you need to! The most common use is to group up existing Xibo operations into something easier to call by the 3rd party! These are documented in our [section on extending Xibo](broken://pages/7039b32911961170b41a0d6a70f1be66912a2c3c).
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xibosignage.com/developer/integrate/integrating-with-xibo.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.