CIA APIs

Introduction

Welcome to the OpenTech Alliance IoE API documentation. This guide covers the recommended usage patterns for calling the service APIs to integrate your property management system with the OpenTech IoE product. First, the document will describe the process for getting started with credentials. Next, the document will describe the Authorization API, which will grant access tokens for use with the other APIs. The document will then cover the Access Control API, which gives you the tools for managing units and tenants. Finally, the guide will cover the Access Event API, which lets you retrieve event data.

Glossary

A unique customer within the OpenTech IoE product who owns one or more facilities.

Application Programming Interface.

A property management system that communicates via service APIs on behalf of an account.

An authorization by an account to an application to grant access to manage account resources.

A self-storage facility belonging to an account, representing all of the units, visitors and other associated resources at that facility.

Gateway Controller at the facility

JSON Web Token, the format for access tokens used to authenticate with service APIs.

Administrators specializing in setting up new accounts and facilities on the platform.

Administrators specializing in troubleshooting issues with existing facilities.

Getting Started

Before you can call any APIs, you’ll need to select an environment and acquire client credentials and at least one set of account credentials for that environment.

Environments

Application and Client Credentials

Account administrators must create an integration to link their account to your application. This will generate an API Key and an API Secret that the account administrator must provide you. These constitute the account credentials that you will use alongside your client credentials to generate an access token from the Authorization API.