API and Webhooks Index

Overview & Getting Started

Web API (Landing Page)
The entry point to BluSKY’s REST API within BluINFO. Explains scope, where to find live API help, and how the web services are organized across objects (people, facilities, access, visitors/vendors, etc.). Use this as home base while exploring specific endpoints.
BluINFO Link. (BluINFO)

API Use Cases
A plain‑language tour of what the BluSKY API enables—from identity sync and co‑working automation to analytics, time & attendance, and emergency notifications. Useful to frame solution concepts before you pick endpoints.
BluINFO Link. (BluINFO)

BluB0X API Guidance (Quick Start + Patterns)
A practical guide for automating data flow from external systems (e.g., AD/HR) into BluSKY via the API. Covers people data, roles, credentials, business rules, and references a quick‑start appendix for first integrations.
BluINFO Link. (BluINFO)

Open Hardware & RESTful Software API (Slides)
Positioning slides that summarize BluB0X’s “open everything” approach—non‑proprietary hardware, RESTful API, and future‑proof integrations. Good context for stakeholders evaluating technical strategy.
BluINFO Link. (BluINFO)

BluSKY Platform Datasheet (Open API + Pub/Sub)
Platform overview with a dedicated Open API section noting service‑oriented architecture and a Publish‑Subscribe model alongside REST/SOAP/JavaScript. Helpful when scoping eventing patterns.
BluINFO Link. (BluINFO)

Authentication, SSO & Identity

Information Security (Detailed Review) – Internet Security Basics
Explains BluSKY’s authentication model, TLS transport, admin login protections, and token‑based flows used by apps to authenticate to the BluB0X API. Sets expectations for secure session handling.
BluINFO Link. (BluINFO)

BluBØX Information Security (Overview)
A higher‑level companion page reiterating authentication, TLS, and mobile token storage practices. Use with the detailed “Internet Security Basics” article for a full picture.
BluINFO Link. (BluINFO)

Understanding SCIM and its Role in BluSKY Integration
How to enable SCIM in BluSKY, generate an API token, and connect common IdPs (Azure AD, Okta, OneLogin). Covers attribute mapping, test runs, and ongoing monitoring.
BluINFO Link. (BluINFO)

SSO Integration (Training Article)
Definitions and overview of SSO in BluSKY, including the Microsoft Azure ecosystem. A good primer for teams evaluating SSO vs. direct credential login for operators.
BluINFO Link. (BluINFO)

BluSKY SSO Compatibility List (Slides)
A historical list of SSO providers known to work with BluSKY (e.g., Azure AD, PingFederate, Okta, OneLogin, SecureAuth, etc.). Use as directional input during planning.
BluINFO Link. (BluINFO)

Login Process: Features & Functions (SSO in Practice)
FAQ‑style article walking through SSO login, two‑factor options, and troubleshooting. Useful for admins and developers testing user journeys.
BluINFO Link. (BluINFO)

API Reference — Core Objects

Tip: Use these object landing pages first; each lists supported methods and then links to individual endpoint pages with request/response schemas and examples.

People & Identity

Person (CRUD + Roles, Cards & Access)
Full user lifecycle (add/update/delete) and management of roles, cards, readers, floors, access levels, and groups. Endpoint list includes AddUser, AddUserRole, AddUserCard, AddAccessLevel, and their removal counterparts.
BluINFO Link. (BluINFO)

Example – AddUserCard
Assigns a credential to an existing user. Supports dynamic card creation (card type, system, internal/external numbers, facility/issue codes) or binding an existing card by ID; includes JSON/XML samples.
BluINFO Link. (BluINFO)

Example – RemoveAccessLevel (for a Person)
Revokes a specific access level previously assigned to a user. Use in deprovisioning flows and HR/identity offboarding automation.
BluINFO Link. (BluINFO)

Organizations & Locations

Occupancy (CRUD + Lookup)
Create and update tenant/occupancy records, retrieve by facility or ID, and integrate space assignments with identity workflows. Includes sample bodies and response shapes.
BluINFO Link. (BluINFO)

Example – AddOccupancy
Adds a new occupancy/tenant object linked to the appropriate Access Control System and facility context. Reference parameters and expected return payloads are provided.
BluINFO Link. (BluINFO)

Facility (Lookup)
Read‑only lookups for facilities—fetch all facilities or retrieve by ID, constrained to the rights granted by the API token.
BluINFO Link. (BluINFO)

Access Model

Access Level (Lookup Example)
Retrieves a specific access level by ID and returns the defined access rights structure. Handy for validating provisioning and for UI‑side selectors.
BluINFO Link. (BluINFO)

Access Level Group (Lookup)
Read endpoints for access level group definitions, typically used for higher‑level policy assignment or to simplify large‑scale provisioning.
BluINFO Link. (BluINFO)

Visitors & Vendors (Programmatic)

Visitor — GetAllVisitorRequestsByFacilityId
Returns visitor requests scoped to a facility (with guest/host details and requested access). Useful for lobby integrations, kiosks, and pre‑reg dashboards.
BluINFO Link. (BluINFO)

Vendor — GetAllVendors
Lists vendors the token can view, including company and occupancy references. Often paired with service assignments and COI workflows.
BluINFO Link. (BluINFO)

Vendor — AddVendor
Creates a vendor entity (name, addresses, AC system, company, optional occupancy, etc.) and returns a result with the primary key of the new record.
BluINFO Link. (BluINFO)

Webhooks & Eventing

Open API — Publish‑Subscribe Model (Datasheet)
The platform datasheet calls out a Publish‑Subscribe model under the Open API section—this underpins event distribution patterns (subscribe/notify), complementary to REST pull. Use this as positioning when selecting push vs. pull.
BluINFO Link. (BluINFO)

Open Hardware & Software — Integrates with Everything (Blog Series)
Several capability round‑ups explicitly note support for RESTful APIs and webhooks, highlighting forward‑leaning integrations (data lake, SIEM, etc.). Good material to set expectations with stakeholders.
BluINFO Link (CRE v2) | Link (CRE v4). (BluINFO)

SIEM Event Forwarding (Licensing)
The licensing catalog lists SIEM usage via Service Bus messages for system event monitoring—a practical indicator of push/event streaming pathways used by enterprises that centralize telemetry.
BluINFO Link. (BluINFO)

Best Practices & Certification

Integration Testing & Certification Process
The authoritative checklist for functional, performance, security, and compatibility testing of BluSKY API integrations. Includes explicit criteria for misuse/abuse and certification denial (e.g., rate‑limit ignorance, IDOR, insufficient logging).
BluINFO Link. (BluINFO)

Integrator Sales Training (Open RESTful API positioning)
Training outline that emphasizes non‑proprietary hardware and the Open RESTful API—useful for aligning sales/solutions teams with what developers will implement.
BluINFO Link. (BluINFO)

Rate Limits & Governance

Rate‑Limit & Resource Governance (Certification Appendix)
Clear call‑outs of what not to do: excessive calls, lack of resource scoping, and missing throttles. Map your client behavior to these expectations to avoid certification delays.
BluINFO Link. (BluINFO)

API Usage (Licensing Signal)
The license catalog includes API usage per transaction as a metered service line item; use this as a reminder to design efficient syncs, caches, and batch operations.
BluINFO Link. (BluINFO)

Release Notes & Updates (API‑Related)

November 2024 — File Retrieval API now uses SAS Token Auth
Updates note SAS token authentication for UI file retrieval and standardized API naming conventions (across C# & Python libraries)—important for client compatibility and secure asset access.
BluINFO Link. (BluINFO)

June 2021 — SIEM Integration noted in updates
Year‑in‑review page referencing the SIEM integration drop; helpful when tracing when certain eventing capabilities landed.
BluINFO Link. (BluINFO)

Legal & Partnership

API Partner Terms
Legal framework for partners using the BluB0X API. Covers fees, support obligations, API updates/versioning expectations, and relationship to API Terms of Use and end‑user agreements.
BluINFO Link. (BluINFO)

Licensing

MSRP Pricing (API & SIEM lines)
Catalog view of BluSKY licenses including API usage per transaction, Single Sign‑On per user, and SIEM service bus messaging. Helps estimate integration‑related operating costs.
BluINFO Link. (BluINFO)

BluSKY License Guidelines
Narrative guidance on license metrics and non‑linear pricing across features like Single Sign‑On, database integration, and more.
BluINFO Link. (BluINFO)

BluSKY Licensing: A Simple, Customer‑Friendly Guide
High‑level explainer of the subscription model, required core licenses, and optional add‑ons (including API usage). Useful when packaging API‑driven solutions.
BluINFO Link. (BluINFO)

Blogs & Positioning (API & Webhooks call‑outs)

Ranked List of BluSKY Features for CRE (v2 & v4)
Market‑facing summaries that explicitly mention RESTful APIs, webhooks, and data‑lake integration as pillars of BluSKY’s openness and extensibility. Good for executive briefings and RFP language.
BluINFO Link (v2) | Link (v4). (BluINFO)

BluB0X & BluSKY (Company/Product Overview)
Positioning page emphasizing open API and non‑proprietary hardware as core to BluSKY’s risk‑free, future‑proof design. Useful anchor for “why open” conversations.
BluINFO Link. (BluINFO)

Differentiators (Open RESTful API)
A compact roll‑up of BluB0X’s unique advantages, including openness (hardware + REST API), analytics/rules, and unified operations—helpful for proposals and evaluations.
BluINFO Link. (BluINFO)