DOCSEARCHbyAlgolia
Submit Docs

2N Developer Documentation

website·Indexed 35 days ago

https://developer.2n.com

Developer resources for 2N products, including the my2n Partner API (PAPI) for managing companies, sites, devices, and users, the my2n SDK, and the 2N Access Commander API v3.6-next for managing users, groups, and user sessions.

Tokens
347.7K
Snippets
1.1K
Records
3K
Agent score
49%

What's inside 2N

  1. Overview of 2N Integration Options

    2N provides several integration paths depending on the target hardware or cloud service:

    • 2N OS HTTP API: Used for building integrations that interact directly with 2N devices.
    • 2N Access Commander: Used to automate access management, synchronize users, and consume real-time events via APIs and SignalR.
    • My2N Partner API: Used to automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Used to integrate My2N mobile video calling and BLE-based access into custom mobile applications.
    • Elevator Center Partner API: Used to automate the lifecycle, configuration, and monitoring of elevator devices.

  2. Overview of 2N Integration Options

    2N provides several integration paths depending on the target system:

    • 2N OS: Use the HTTP API to interact directly with 2N devices.
    • 2N Access Commander: Use APIs and SignalR to automate access management, synchronize users, and consume real-time events.
    • My2N Partner API: Automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Integrate BLE-based access and mobile video calling into custom mobile applications.
    • Elevator Center Partner API: Automate the lifecycle, configuration, and monitoring of elevator devices.

  3. Overview of 2N Integration Options

    2N provides several integration paths depending on the target hardware or service:

    • 2N OS: Use the HTTP API to interact directly with 2N devices.
    • 2N Access Commander: Use APIs and SignalR to automate access management, synchronize users, and consume real-time events.
    • My2N Partner API: Use for automating My2N cloud configuration and building cloud-to-cloud integrations.
    • My2N SDKs: Use to integrate BLE-based access and mobile video calling into custom mobile applications.
    • Elevator Center Partner API: Use to automate the lifecycle, configuration, and monitoring of elevator devices.

  4. Overview of 2N OS and HTTP API (HAPI)

    2N OS is the core operating system for 2N IP intercoms, access control readers, and indoor stations. It provides a central layer for device functionality and integration. For developers, the primary interface is the HTTP API (HAPI), which allows for remote control, monitoring, and automation of device behavior via standard HTTP/HTTPS protocols.

  5. Overview of 2N Integration Options

    Depending on the target goal, 2N provides several integration paths:

    • 2N OS: Use the HTTP API to build integrations that interact directly with 2N devices.
    • 2N Access Commander: Use APIs and SignalR to automate access management, synchronize users, and consume real-time events.
    • My2N Partner API: Use this for cloud-to-cloud integrations and automating My2N cloud configuration.
    • My2N SDKs: Use these to integrate BLE-based access and mobile video calling into custom mobile applications.
    • Elevator Center Partner API: Use this to automate the monitoring, configuration, and lifecycle of elevator devices.

  6. Overview of 2N Integration Options

    2N provides several integration paths depending on the target system:

    • 2N OS: Use the HTTP API to interact directly with 2N devices.
    • 2N Access Commander: Use APIs and SignalR to automate access management, synchronize users, and consume real-time events.
    • My2N Partner API: Automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Integrate BLE-based access and mobile video calling into custom mobile applications.
    • Elevator Center Partner API: Automate the lifecycle, configuration, and monitoring of elevator devices.

  7. Overview of 2N Integration Options

    2N provides several integration paths depending on the target hardware and management layer:

    • 2N OS: Use the HTTP API to interact directly with 2N devices.
    • 2N Access Commander: Use APIs and SignalR to automate access management, synchronize users, and consume real-time events.
    • My2N Partner API: Use for automating My2N cloud configuration and cloud-to-cloud integrations.
    • My2N SDKs: Use to integrate BLE-based access and mobile video calling into custom mobile applications.
    • Elevator Center Partner API: Use to automate the lifecycle, configuration, and monitoring of elevator devices.

  8. Overview of 2N Integration Options

    2N provides several integration paths depending on the target system:

    • 2N OS HTTP API: Used for building integrations that interact directly with 2N devices.
    • 2N Access Commander: Used to automate access management, synchronize users, and consume real-time events via APIs and SignalR.
    • My2N Partner API: Used to automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Used to integrate My2N mobile video calling and BLE-based access into custom mobile applications.
    • Elevator Center Partner API: Used to automate the lifecycle, configuration, and monitoring of elevator devices.

  9. Overview of 2N Integration Options

    2N provides several integration paths depending on the target system and desired functionality:

    • 2N OS HTTP API: Used to build integrations that interact directly with 2N devices.
    • 2N Access Commander: Used to automate access management, synchronize users, and consume real-time events via APIs and SignalR.
    • My2N Partner API: Used to automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Used to integrate My2N mobile video calling and BLE-based access into custom mobile applications.
    • Elevator Center Partner API: Used to automate the lifecycle, configuration, and monitoring of elevator devices.

  10. Overview of 2N Integration Options

    2N provides several integration paths depending on the target system and desired functionality:

    • 2N OS HTTP API: Used for building integrations that interact directly with 2N devices.
    • 2N Access Commander: Used to automate access management, synchronize users, and consume real-time events via APIs and SignalR.
    • My2N Partner API: Used to automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Used to integrate My2N mobile video calling and BLE-based access into custom mobile applications.
    • Elevator Center Partner API: Used to automate the lifecycle, configuration, and monitoring of elevator devices.

  11. Overview of 2N Access Commander SignalR Topics

    2N Access Commander uses SignalR topics to push real-time updates to clients. All listed topics support 'FilterFetchUpdate' capabilities. Available topics include:

    • accesslog: Triggered when a new access log entry is created.
    • areachange: Triggered by anti-passback/occupancy area state changes or user block/unblock events.
    • automationstate: Triggered when the Node-RED service state changes.
    • backgroundjobs: Provides updates on background job state, results, errors, or individual parts.
    • calllog: Triggered when a new call log entry is created.
    • devicemonitor: Triggered by changes in monitored device properties (e.g., device state, SIP proxy registration, audio test, tamper switch, door state, or lift module state).
    • firmware: Triggered when firmware updates become available, complete, or fail. Note: This event has no payload; use the firmware HTTP API for details.
    • license: Triggered when a license is added, about to expire, or has expired.
    • lockdown: Triggered when the lockdown state changes for a device, zone, company, or the entire system.
    • notifications: Triggered when a new notification appears in the notification center.
    • presence: Triggered when the presence list is modified. Use the HTTP API to retrieve the full list.
    • systemlog: Triggered when a new system log entry is created.
    • systemresources: Reports server utilization (CPU, RAM, disk usage) every second.
    • uptime: Reports server uptime every second (primarily for development/testing).
    • userchange: Triggered when a user is modified or deleted.
    • zoneaccess: Triggered when a user's zone access changes (e.g., access granted or credentials changed).

  12. Overview of 2N Integration Options

    2N provides several integration paths depending on the target hardware or cloud service:

    • 2N OS HTTP API: Used for building integrations that interact directly with 2N devices.
    • 2N Access Commander: Used to automate access management, synchronize users, and consume real-time events via APIs and SignalR.
    • My2N Partner API: Used to automate My2N cloud configuration and enable cloud-to-cloud integrations.
    • My2N SDKs: Used to integrate My2N mobile video calling and BLE-based access into custom mobile applications.
    • Elevator Center Partner API: Used to automate elevator device lifecycle, configuration, and monitoring.