Before moving to the actual tutorial make sure you have the working API key to use with the requests.
In all of the examples we will use the
YOUR-API-TOKEN string to indicate the location where you should
fill in the value of your API token.
You can use the following example to verify you have a working API key. This is a simple GET request of static data which will not make any changes to the backend system.
curl -X GET \ -H "Congrid-API-Token: YOUR-API-TOKEN" \ -H "Content-Type: application/json" \ "https://api.congrid.com/v1/floorPlanTypes"
To get the API key visit the Congrid Live UI users page and search for your company API user:
Only the company level administrator user is able to access and modify the API token.
API User Types
There are two different kind of API users:
- API user with read-write access
- API user with read-only access
For part I of this tutorial read-write access is required but for part II it is enough to have read-only access.