Documentation

REST API is documented in the OpenAPI format and is available via Swagger UI. Interactive documentation lets you explore the structure of requests and responses, test methods directly in the browser, and use the specification to automatically generate client libraries.

The platform API covers the main engineering entities of Seenaptec:

• controllers and OSDP lines;
• devices and their components;
• equipment vendors and models;
• access objects and their types;
• platform configuration;
• authentication and security parameters.

The documentation contains descriptions of data models, request parameters, response codes, and usage examples for integration with external systems.

Main API sections

• Controllers
• OSDP Lines
• Devices
• Access Objects
• Vendors & Models
• Security API
• Health API

Test

Up-to-date documentation on the installation, configuration, and operation of Seenaptec Access Platform.

The guide contains descriptions of:

• platform architecture;
• access objects;
• users and access cards;
• hardware and OSDP;
• event logs;
• firmware updates;
• redundancy and service functions;
• system administration.

Open the guide

This section contains the latest versions of software and accompanying components of the platform.

Available:

• Seenaptec Access Platform Server;
• platform services;
• OSDP components;
• configuration examples;
• change log (Release Notes);
• file checksums.

For each version, information on compatibility, fixes, and new features is published.

Go to downloads

Materials for developers, integrators, and equipment manufacturers.

The section includes:

• OpenAPI YAML;
• Postman collections;
• REST request examples;
• data models;
• integration guidelines;
• examples of working with equipment and access facilities.

The materials enable quick integration of the platform with external information systems, services, and custom applications.

If the required information is not available in the documentation, Seenaptec engineers will assist with the design, implementation, and integration of the platform.

Request a consultation