Authorization

Single User Client

Please contact simpl.rent to obtain API access.

Authenticate by adding the Authorization: <API KEY> header to your request.

Request Example
curl https://api-test.simpl.rent/v2/account -H 'Authorization:<API KEY>'

Multiple Users Client

Please contact simpl.rent to obtain your clientID.

The client system should assign a unique UserID to each user.

  1. Users can grant access to their data to a client system by registering via the following link:
    https://app.simpl.rent/r/<clientID>?ext=<UserID> - production environment
    https://test.simpl.rent/r/<clientID>?ext=<UserID> - test environment

  2. Alternatively, users can obtain their UserID from the client system and copy-paste it into the dashboard settings section.

If a request contains the UserID header, API operations will be performed on behalf of the user associated with it.

If the user has not granted access or if access has been revoked, the endpoints will respond with a 401 HTTP status code.

The UserID should have at least four characters.

Authenticate by adding the Authorization: <API KEY> and UserID: <User ID> headers to your request.

Request Example
curl https://api-test.simpl.rent/v2/account -H 'Authorization:<API KEY>' -H 'UserID: <User ID>'
Account