KIWI API

+(pause=TGJZRTEtWmdKTWNIYi5SSfb0bWFtdGJcWTgpJ1RWTXpMRndrdz+TcXcNPbzFNSGNuRWquW2ZxaqdG5Transport](https://api.kiwi.ki/v1/spec.json)\nThis is the documentation for the HTTP API provided by KIWI.KI GmbH for remote unlocking and administration of doors.

This API can be used for integration into existing systems and for application development.

Authorize

Session

Managing user session (logging in/out)

DELETE /v1/session/ Clean up user session
POST /v1/session/ Create user session

Permission

Managing access rights

POST /v1/permissions/user/sensor/ Create a new user - sensor permission
DELETE /v1/permissions/{permission_id}/ Delete a user - sensor permission.
PUT /v1/permissions/{permission_id}/ Edit a user - sensor permission.

Sensor

Managing door sensors

POST /v1/friendly_names/sensor/{sensor_id}/ Assign a custom name to a sensor (friendly name)
GET /v1/sensors/ Get a list of visible sensors
GET /v1/sensors/{sensor_id}/ Get sensor details
POST /v1/sensors/{sensor_id}/act/{action}/ Send a command to a sensor
GET /v1/sensors/{sensor_id}/permissions/ Get sensor permissions

Address

GET /v1/addresses/search/ Find an address in KIWI database

Organization

GET /v1/organizations/{organization_id}/custom-attributes-data/sensor/{sensor_id}/ Get an organization sensor's custom attributes data

Parameters

Name	Description
organization_id \
integer \
(path)	Example : 1001
sensor_id \
integer \
(path)	Example : 45678

Responses

Response content type application/json

Code	Description
200	Organization custom attributes data - Example Value - Model `json<br>{<br> "result": {<br> "attributes": [<br> {<br> "key": "FLDT2sCgX",<br> "label": "My custom attribute",<br> "value": "Attribute data"<br> }<br> ]<br> },<br> "status": "ok"<br>}<br>`
400	Malformed request content - Example Value - Model `json<br>{<br> "message": "Invalid parameters ...",<br> "status": "error",<br> "status_code": 400,<br> "status_long_message": "Bad request syntax or unsupported method",<br> "status_short_message": "Bad Request"<br>}<br>`
401	Authorization failed for the resource - Example Value - Model `json<br>{<br> "message": "Invalid username or password",<br> "status": "error",<br> "status_code": 401,<br> "status_long_message": "No permission -- see authorization schemes",<br> "status_short_message": "Unauthorized"<br>}<br>`
403	Not allowed to perform this operation - Example Value - Model `json<br>{<br> "message": "Not allowed to perform this operation",<br> "status": "error",<br> "status_code": 403,<br> "status_long_message": "Request forbidden -- authorization will not help",<br> "status_short_message": "Forbidden"<br>}<br>`
404	Resource was not found - Example Value - Model `json<br>{<br> "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",<br> "status": "error",<br> "status_code": 404,<br> "status_long_message": "Nothing matches the given URI",<br> "status_short_message": "Not Found"<br>}<br>`

POST /v1/organizations/{organization_id}/custom-attributes-data/sensor/{sensor_id}/ Edit an organization sensor's attribute (one or multiple)
GET /v1/organizations/{organization_id}/custom-attributes/sensor/ Get a list of organization's custom attributes
POST /v1/organizations/{organization_id}/custom-attributes/sensor/ Create an organization's custom attribute
DELETE /v1/organizations/{organization_id}/custom-attributes/sensor/{attrib_key}/ Delete an organization's custom attribute
POST /v1/organizations/{organization_id}/custom-attributes/sensor/{attrib_key}/ Edit an organization's custom attribute label
GET /v1/organizations/{organization_id}/custom-fields/ Get a list of organization's custom fields
POST /v1/organizations/{organization_id}/custom-fields/ Create an organization's custom field
GET /v1/organizations/{organization_id}/custom-fields/user/{user_id}/ Get a list of the user's custom fields
GET /v1/organizations/{organization_id}/custom-fields/{field_id}/ Get a user's custom field
POST /v1/organizations/{organization_id}/custom-fields/{field_id}/ Edit user's custom field value
DELETE /v1/organizations/{organization_id}/custom-fields/{field_id}/manage/ Delete an organization's custom field
POST /v1/organizations/{organization_id}/custom-fields/{field_id}/manage/ Edit organization's custom field name

Task

GET /v1/tasks/{task_id}/ Get information about the status of a task

User

POST /v1/users/ Create a new user account
GET /v1/users/permissions/ Get user permissions
GET /v1/users/{user_id}/ Get detailed user information
DELETE /v1/users/{user_id}/email/ Remove a user's email address
PUT /v1/users/{user_id}/email/ Change a user's email address
POST /v1/users/{user_id}/move/out/ Move tenant out of an organization

Models

Address
AddressResult
CustomAttribute
EmailChangeResult
EmailRemovedResult
FnameSet
OrganizationCustomAttributeCreated
OrganizationCustomAttributeCreatedResult
OrganizationCustomAttributeDataEditedResult
OrganizationCustomAttributeDeletedResult
OrganizationCustomAttributeEditedResult
OrganizationCustomAttributesData
OrganizationCustomAttributesDataResult
OrganizationCustomAttributesList
OrganizationCustomAttributesListResult
OrganizationCustomFieldCreated
OrganizationCustomFieldCreatedResult
OrganizationCustomFieldDeletedResult
OrganizationCustomFieldEdited
OrganizationCustomFieldEditedResult
OrganizationCustomFieldsList
OrganizationCustomFieldsListResult
OrganizationUserCustomField
OrganizationUserCustomFieldResult
OrganizationUserCustomFieldsList
OrganizationUserCustomFieldsListResult
PermissionCreated
Sensor
SensorPermission
SensorPermissionsResult
SensorResult
SensorSingleResult
Session
SessionResult
Task
User
UserCreated
UserCreatedResult
UserCustomFieldValueEdited
UserCustomFieldValueEditedResult
UserMovedOut
UserPermission
UserPermissionsResult
UserResult

responses