Overview
Share911 accepts requests to register visitors via our REST API.
In order to use the API your user account will need 2 things:
- Manage Users or Manage Visitors permission
- An API key
To receive your API key, please contact support@share911.com.
API
Endpoint
REST Endpoint: https://api.share911.com/v1/visitors/
NOTE: The slash "/" at the end of the URL is required! Visiting this URL through a browser will not allow visitors to be registered. This URL is only for REST calls.
Authentication
Basic authentication. The username is always "api". The password is the API key provided by Share911 Support.
Payload
The REST request should include data in JSON format. The fields are:
visitorId
A unique string identifying the visitor.
Example: bnuw342z3
siteId
A unique string identifying a building. This corresponds to the Channel ID of the target communication channel in Share911. To find the Channel ID, log in to Share911 and select the appropriate channel. The Channel ID will be the part of the URL following "https://share911.com/".
Share911 also supports Custom Channel IDs. The custom code can be any alphanumeric string, typically customers would use the same code that their HR or SIS uses for the building. Custom Channel IDs can be configured on the Manage Channel => Registration page.
Example: "acme/hq"
integrationId
An ID identifying the integration / partner / company which is sending the alert, in string format. This is used to prevent re-triggering the corresponding system when 2-way integration is enabled.
Example: acme
firstname
The first name of the visitor.
Example: Mark
lastname
The last name of the visitor.
Example: Smith
mobile
The mobile phone number of the visitor. Should include digits only.
Example: 5555555555
timestamp
Visitor registration time, in ISO 8601 format.
Example: 2024‐07‐12T16:16:00+03:00
action
One of: sign-in, sign-out
email
[OPTIONAL]
The email address of the visitor.
Example: msmith@example.com
destinationLocation
[OPTIONAL]
The person and/or location that the visitor is visiting
Example: Ms. Landers, Room 204
entranceLocation
[OPTIONAL]
The entrance that the visitor came in through
Example: Main Entrance
Examples
GENERIC
curl --user 'api:<YOUR API KEY>' \
https://api.share911.com/v1/visitors/ \
-H "Content-Type: application/json" \
-d '{
"visitorId": "<VISITOR ID>",
"siteId": "<CHANNEL ID>",
"integationId": "<INTEGRATION_ID>",
"firstname": "<FIRSTNAME>",
"lastname": "<LASTNAME>",
"mobile": "<MOBILE>",
"email": "<EMAIL>",
"destinationLocation": "<DESTINATION DESCRIPTION>",
"entranceLocation": "<ENTRANCE DESCRIPTION>",
"timestamp": "<ISO8601 TIMESTAMP>",
"action": "<ACTION>"
}'
VISTOR REGISTRATION
curl --user 'api:<YOUR_API_KEY>' \
https://api.share911.com/v1/visitors/ \
--header 'Content-Type: application/json' \
--data-raw '{
"visitorId": "bnuw342z3",
"siteId": "acme/hq",
"integationId": "partnerId",
"firstname": "Mark",
"lastname": "Smith",
"mobile": "5555555555",
"email": "msmith@example.com",
"destinationLocation": "Ms. Landers, Room 204",
"entranceLocation": "Main Entrance",
"timestamp": "2024‐07‐12T16:16:00+03:00",
"action": "sign-in"
}'
VISITOR DE-REGISTRATION
curl --user 'api:<YOUR_API_KEY>' \
https://api.share911.com/v1/visitors/ \
--header 'Content-Type: application/json' \
--data-raw '{
"visitorId": "bnuw342z3",
"siteId": "acme/hq",
"integationId": "partnerId",
"action": "sign-out"
}'
Verification
Users with appropriate permissions can view visitors in Share911's admin interface by opening their User Menu in the top right, and selecting Manage People, then Visitors Directory.