Web Service API (API)

The IBSSweb Web API module is an add-on RESTful web service that integrates seamlessly to the IBSSweb security management system software.

Enquiry
Web Service API (API)

This module empowers developers to remotely control and monitor various aspects of the system including access control, intrusion detection and facilities booking.

Built on ASP.NET Web API technology, this module supports HTTP-based communications for effortless integration to other diverse applications and systems.

IBSSweb Web Service API Structure Diagram
IBSSweb Web Service API for Lift Integration

Key Features

  • RESTful architecture to integrate effortlessly with any system using widely adopted RESTful principles
  • Comprehensive functionality to control access,
    manage intrusion and make bookings for facilities with a single, unified API
  • Secure communications using robust HTTP-based protocol (including HTTPS) to prevent unauthorized access and protect sensitive data
  • Flexible integration with various applications and systems and maximize the power of the IBSSweb security management system
  • Accelerate integration with the developer friendly code samples and comprehensive documentation
  • Automate tasks, streamline operations and boost productivity to enhance efficiency

Major Applications

  • Physical Security Information Systems (PSIM)
  • Building Management Systems (BMS)
  • Visitor Management Systems
  • Time & Attendance Systems
  • Security Monitoring & Reporting Systems
  • Custom Applications for Integration to Access Control and Security Systems

Summary of Contents

  • Access Control
    – Access Grant
    – Arm Door / Disarm Door
    – Lock Door / Unlock Door
    – Execute Action
    – Add / Modify Cardholder
    – Delete / Enable / Disable Card
    – Add / Modify Cardholder Card for Visitor
  • Facilities Booking
    – Add / Modify / Cancel Booking
  • Intrusion
    – Arm / Disarm Input
    – Activate / De-activate Output
  • Get Device Status
    – Door Secured / Unsecured Status
  • Status Codes

 

  • System
    – Check Communications
    – Event Subscribe
    – Add / Get Events
    – Acknowledge / Reset Alarms
  • Database Tables Data
    – Data Design
    – Devices Data
    – Controllers Devices Data
    – Cardholders / Cardholders Card Data
    – Event Types
    – Retrieve UAG Information
  • Calling IBSSweb API from .NET Client
    – Creating console application
    – Install NuGet Package Manager
    – Install Web API Client Libraries
    – Adding IBSSweb API Reference
    – Using HTTP Client to Grant Access to a Door

Important Notes to Developers

  • Authentication and Authorization
    The IBSSweb Web API requires authentication and authorization for all requests. Developers need to provide valid credentials (Login ID & Password) with each request to ensure secure access to the API.
  • Error Handling
    The API provides detailed error messages and status codes to assist developers in troubleshooting and resolving issues encountered during integration.
  • Documentation
    Comprehensive documentation with detailed information on each command, including request parameters, response formats and code samples.
  • Libraries
    Client libraries available for various programming languages to simplify the integration process.
Specifications IBSSweb-API
API Type RESTful Web Service
Architecture ASP.NET Web API
Communications Protocol / Standards HTTP / HTTP Status Codes
Supported Method GET, POST
Operating Systems / Programming Languages Windows, Linux, macOS / .NET, Java, Python, etc.
Security Authentication and Authorization Mechanisms
Error Handling Error messages and status codes
Deployment Options On-Premise, Cloud

*Specifications are subject to change without prior notice

Datasheet
Model No. Description
IBSSweb-API IBSSweb Web Service API
Have a Question?
For assistance... For assistance... 65 6844 2141