Create an API & API Key

An API is a way for software to communicate with one another. DaVinci Lock® has implemented features that allow third parties, such as call centers, to retrieve DaVinci Lock® information for units in your facilities. To ensure the information remains safe, the API creates a barrier that allows access for only you and one other party. When partnering with a third-party call center, the call center requires access to specific information including the unlock code for your DaVinci Lock. To seamlessly retrieve information, the third party will need:

• API Key

• API Secret

• Facility API ID’s for all the facilities associated with the API Key that you want them to be able to access

For safety, the API Key or Secret should not be shared with more than one party or outside of the party as it acts as security for DaVinci Lock® codes. DaVinci Lock® is not responsible for loss of control to this value. Should the information become public, you should immediately lock the associated API, create a new one, and provide the new information to the appropriate party. Information on API documentation can be found here.

Creating and modifying API keys

1. Sign in to your DaVinci Lock® account. 
2. Integrations", navigate to the “API Settings” tab.

 3.   Click "Create API Key".

 4.   In the “Name” field, add a descriptive name for the key. This should be something that helps identify the purpose of the key. For example, “Call Center”. These names are not unique and are only used to serve as a human-readable-identifier.

5. To add the key for all facilities, ensure the “All Facilities” toggle is turned on. If the key is only for specific facilities, toggle off "All Facilities" and manually select each facility. At least one facility must be selected for the key.

6. Click “Save & Submit” to create the key. Once submitted, a new entry will be added to the list of keys.

7. From the list of keys, click on the key you wish to view the API Secret for.

8. Click “Show Key” to reveal the API Secret or use this window to update the facility information.

9. Copy the API Key and API Secret from this window to send to the third party, if applicable. If the API Key or API Secret becomes compromised you should disable it and create a new key.

Retrieving facility API IDs

1. Sign in to your DaVinci Lock® account.
2. Click "Integrations", navigate to the "Facilities" tab. 

3. Locate the facility, and retrieve the facility ID from the “Facility ID” column. The facility ID is automatically created at the time a facility is created.

Toggling facilities for inclusion or exclusion in the API

By default, all facilities are included in the API. To exclude a facility from an API:

1. Sign in to your DaVinci Lock® account.
2. Click "Integrations", navigate to the "Facilities" tab. 

3. Toggle on/off the facility in the “Include in API” column. Excluding a facility from the API will also remove it from OverlockRelease.com.