Documentation

All materials required for designing, integrating, deploying, and operating the Seenaptec Access Platform. Here you can find guides, REST API documentation, OpenAPI specifications, and developer resources.

Seenaptec Access Platform

Guides, REST API, OpenAPI, distributions, developer materials

OpenAPI / Swagger

Platform REST API

REST API is documented in the OpenAPI format and is available via Swagger UI. The interactive documentation allows you to explore the structure of requests and responses, test methods directly in the browser, and use the specification for automatic generation of client libraries.

The platform API covers Seenaptec's core engineering entities:

controllers and OSDP lines;
devices and their components;
equipment manufacturers and models;
access objects and their types;
platform configuration;
authentication and security settings.

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

Core API sections

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

Test

User Guide

Operational documentation

Up-to-date documentation for installing, configuring, and operating Seenaptec Access Platform.

The guide contains a description of:

platform architecture;
access objects;
users and passes;
equipment and OSDP;
event logs;
firmware updates;
reservation and service functions;
system administration.

Open guide

Distributions

Software

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

```html

Available:

```

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

Compatibility information, fixes, and new features are published for each version.

Go to downloads

Integration tools

SDK and materials for developers

Resources for developers, integrators, and equipment manufacturers.

The section includes:

OpenAPI YAML;
Postman collections;
REST request examples;
data models;
integration recommendations;
examples of working with equipment and access objects.

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

Support

Technical Documentation and Help

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

Get a consultation