IRIS+™ Rest API

the iris+™ api has been created to provide secure and easy access to your account data to support custom use cases and integration needs it is built using restful principles the api is normally disabled please reach out to our support or sales organization to enable access to the api for your account and installation the current version is version 2 endpoint and documentation the main endpoint for the api is https //api irisplus ai/docs/#iris external api version 3 https //api irisplus ai/docs/#iris external api version 3 this is also where you find the detailed api documentation the main endpoint for the api is https //api irisity io/v2 https //api irisity io/v2 getting started to get access to the functionality of iris+ api you will need an api key and an access token api key the system administrator needs to create an api key with the relevant permission for iristy hosted cloud accounts, please contact irisity support to get an api key customer support technicalsupport\@irisity com mailto\ technicalsupport\@irisity com log in as system administrator go to the console tab and then choose api keys 3\ click + add 4\ set key name 5\ click "+ add" 6\ select the api key in the list and add the below permissions, depending on needs to maximize security, make sure to only grant access to the functionality required accounts > read events > read, update folders > read rules > read cameras > read, update click "save" deliver the api key securely to the intended customer access token the administrator of the relevant account needs to create a service account to be able to generate an access token for the api calls create a service account log in as an account administrator go to settings and then the user tab click "+ add" 4\ choose "create service account" and pick a name 5\ (optional) add a description 6\ click "create service account" generate an access token select the service account click "get token" (recommended) check the "token expiration" and choose the expiration date we always recommend setting a token expiration to enforce rotating keys periodically click "get token" copy the token and store it securely for later use using the api to start using the external api, you need to set two custom headers, x api key and x access token add the api key generated above as the value for the x api key header add the access token generated above as the value for the x access token header your first request to verify your api access you can use curl to get a list of all sensors (cameras) in the account curl is built into most modern operating systems for more details, please see https //github com/curl/curl https //github com/curl/curl curl request curl https //api irisplus ai/v2/sensors https //api irisity io/v2/sensors h "x api key {api key}" h "x access token {access token}" full documentation for details about the available operations, options, and data types, please refer to the api documentation at https //api irisity io/v2 https //api irisity io/v2