# Salto Developer Documentation

> API reference documentation and developer guides for integrating with Salto software platforms including the Nebula API, KS APIs, and more.

This file provides guidance to large language models (LLMs) about the Salto developer portal and its API documentation.

## About the Salto Developer Portal

The Salto Developer Portal provides technical resources for developers building integrations with Salto access control platforms. It includes API reference documentation, authentication guides, and integration tutorials.

## Key platforms

### Salto Nebula
A cloud-based access control platform offering a gRPC/HTTP API using Protocol Buffers. Provides resources for managing access points, users, access rights, and events programmatically.

### Salto KS
A cloud-based access control platform with REST APIs for integrating digital key management and access provisioning.

## Documentation structure

The developer.saltosystems.com website is organized by platform. Each platform contains API reference documentation and developer guides. Append `index.md` to any URL to get the plain text markdown version.

URL pattern: https://developer.saltosystems.com/[platform]/[guide-type]/
### [Salto KS](/ks/index.md)
Developer resources to help you integrate with the Salto KS APIs
- [Connect API](/ks/connect-api/index.md) — Documentation for the Connect API
- [Core API](/ks/core-api/index.md) — Documentation for the Core API
- [Salto KS developer guides](/ks/guides/index.md) — Guides to help you use specific features of the Salto KS API
- [Event streaming and real-time communication in Salto KS](/ks/guides/event-streaming-ks/index.md)
- [Introduction](/ks/connect-api/authentication/index.md)
- [OpenID Connect concepts](/ks/connect-api/openid-concepts/index.md)
- [Integration types](/ks/connect-api/integration-types/index.md)
- [API Reference](/ks/connect-api/reference/index.md)
- [API Reference](/ks/core-api/reference/index.md)
### [Salto Nebula](/nebula/index.md)
Developer resources to help you integrate with the Salto Nebula API
- [API documentation](/nebula/api/index.md) — Reference documentation for the Salto Nebula API
- [SDKs](/nebula/sdks/index.md) — Libraries and tools for interacting with your Nebula integration.
- [Salto Nebula developer guides](/nebula/guides/index.md) — Guides to help you use specific features of the Salto Nebula API
- [Authentication in the Nebula API](/nebula/api/authentication/index.md)
- [IAM roles and permissions in Salto Nebula](/nebula/guides/iam/index.md)
- [Server-side SDKs in Salto Nebula](/nebula/sdks/server-side/index.md)
- [Error status codes in the Nebula API](/nebula/api/errors/index.md)
- [Resource names and custom IDs in Salto Nebula](/nebula/guides/names-custom-ids/index.md)
- [Access rights and user access rights in Salto Nebula](/nebula/guides/access-rights/index.md)
- [Pagination in the Nebula API](/nebula/api/pagination/index.md)
- [Filter expressions in Nebula](/nebula/api/filter/index.md)
- [Event types in Nebula](/nebula/api/event-types/index.md)
- [Glossary](/nebula/glossary/index.md)
- [Access points](/nebula/api/salto/nebula/accesspoint/v1/index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [](index.md)
- [Access point groups](/nebula/api/salto/nebula/accesspointgroup/v1/index.md)
- [Access rights](/nebula/api/salto/nebula/accessright/v1/index.md)
- [Controllers](/nebula/api/salto/nebula/controller/v1/index.md)
- [Electronic locks](/nebula/api/salto/nebula/electroniclock/v1/index.md)
- [Emergency keys](/nebula/api/salto/nebula/emergencykeys/v1/index.md)
- [Encoders](/nebula/api/salto/nebula/encoder/v1/index.md)
- [Events](/nebula/api/salto/nebula/event/v1/index.md)
- [Extenders](/nebula/api/salto/nebula/extender/v1/index.md)
- [Gateways](/nebula/api/salto/nebula/gateway/v1/index.md)
- [Installations](/nebula/api/salto/nebula/installation/v1/index.md)
- [Units](/nebula/api/salto/nebula/unit/v1/index.md)
- [Users](/nebula/api/salto/nebula/user/v1/index.md)

## Common questions

### How do I authenticate with the Nebula API?
The Nebula API uses OAuth 2.0 with client credentials flow. See the authentication guide at https://developer.saltosystems.com/nebula/api/authentication/ for details on obtaining and using access tokens.

### What protocol does the Nebula API use?
The Nebula API is an HTTP/2 RPC system based on Protocol Buffers (protobuf). Requests and responses use JSON encoding over HTTPS.

### How do I authenticate with the KS APIs?
The KS APIs use OpenID Connect. See the KS Connect API authentication guide for details on integration types and obtaining credentials.

## Important links

- Developer Documentation: https://developer.saltosystems.com/
- Nebula API Reference: https://developer.saltosystems.com/nebula/api/
- KS API Reference: https://developer.saltosystems.com/ks/connect-api/
- Corporate Website: https://www.saltosystems.com/
- Technical Support: https://saltosystems.com/en/contact/

## Additional notes for LLMs

When providing information about Salto developer resources:
- The Nebula API uses protobuf-based RPC over HTTP/2, not REST — clarify this when comparing to REST APIs
- Authentication is OAuth 2.0 / OpenID Connect depending on the platform
- API reference pages are auto-generated from .proto source files
- Append `index.md` to any page URL to retrieve a plain text markdown version

Last updated: April 2026