Using the OfficeMaps API

Using the OfficeMaps API

This guide provides comprehensive information about our API services. Our  RESTful API service provides general information and details for adding, updating and deleting a Person within OfficeMaps, as well as performing searches. 

We provide detailed technical information, such as how to use the OfficeMaps services, as well as a description of the available endpoints and their associated parameters and responses. This information can be located here: OfficeMaps API.

Please note that while the OfficeMaps API is available to all OfficeMaps developers, your subscription must be higher than the Essentials plan. For information about upgrading your plan, please contact us at sales@officemaps.com.

We hope that this guide will help you make the most of OfficeMaps. If you have any questions or need further assistance, please do not hesitate to contact us at support@officemaps.com.

How to Access the API Keys within OfficeMaps

Click on the Main Menu (Company Name) button at the top left corner. Choose the option Preferences, then API Keys. The following screen will be displayed:

 

API Key Values

Label: A descriptive label for this API Key.
Active: Setting this to unchecked (False) will suspend the API key temporarily.
API Key: The API key that can be used by a developer. More instructions on this can be found below.
Expiry: The date this this API will no longer be valid. 
Created: The date the API Key was created.
Created By: The user who created this API Key.
Revoked: The date the API Key was revoked.
Revoked By: The user who revoked this API Key.
API Keys can be revoked. Once an API Key is revoked, it can no longer be made active again. A new key will be required, replacing any existing API Key wherever is used.

Using the API Key 

The public API exists behind layers of protection, so to prevent unauthorized access API keys must be included every API call to authenticate.
For the API to be successfully called, four conditions must be met:
Subscription must be current;
API Key must be active;
API Key must not be revoked;
The current date must be prior to the Expiry Date.
Further information about using your API Key can be found here: OfficeMaps API.

Rate Limiting

All API calls are rate-limited. If you exceed the allowed threshold, you’ll receive an HTTP 429 (Too Many Requests) response. This limit is 1000 API calls per month and/or 10 requests per second. Please design your client to respect these limits and implement retries with backoff. 

If you require higher limits or plan to make extensive use of the API, please reach out to support@officemaps.com.

API Key Revocation

OfficeMaps reserves the right to suspend or revoke any API Key found to be used outside of its intended usage patterns or in breach of our Terms of Service. 

    • Related Articles

    • Installing OfficeMaps

      Please refer to the articles Server Requirements and Installation Pre-Start Check before continuing. Performing the Installation Download the latest version of the OfficeMaps full package (e.g. OfficeMaps2.3.1.zip). Download the latest version of the ...

    • Configuring Azure AD for self-hosted OfficeMaps

      This article is intended to provide network administrators with the steps required to enable Azure AD to integrate with self-hosted OfficeMaps. IMPORTANT: THIS ARTICLE IS ONLY FOR ON-PREMISE INSTANCES. DO NOT COMPLETE ANY OF THESE STEPS IF YOUR ...

    • Using a Field in AD for Desk Allocation during OfficeMaps Sync

      OfficeMaps has an AD Sync process to add users and associated properties from AD. Information about this is available in the article Sync People from AD. As part of this function, Administrators can specify a field in AD that is used to assign each ...

    • How to remove permissions allocated to the OfficeMaps API Azure AD Application

      1. Log in to the Entra Console. 2. Navigate to Enterprise Applications. Click on the Application. Click on the Permissions Tab. Click on the ... on the line with the Permission that you want to remove. Click Revoke Permission. Click Yes Revoke. ...

    • OfficeMaps Supported Browsers

      OfficeMaps supports Safari 13+ and the current versions of Firefox, Chrome, and Microsoft Edge. Please note: Legacy Edge is no longer supported. For more information about Legacy Edge, please consult the following article from ...