Casavi

Casavi API Integration Documentation and Authentication

Introduction

Casavi is the leading platform for digitization in real estate management.

Base url: https://api.mycasavi.com/

Casavi's system-status can be seen here.

Casavi Authentication

Casavi uses and a key and secret that is provided by Casavi itself. The user has to provide it upon authentication. There is no refreshing mechanism, but the token received upon initial authentication is valid for one month in the standard-setting.

1. To start authentication make a POST against https://api.mycasavi.com/authenticate with the header Content-Type: application/json The body should be { "key":"xyz", "secret":"xyz" } While the details are provided by Casavi

2. You will receive back: { "token": "xyz", "expiresAt": "2020-12-10T20:52:53Z" }

3. Start making request with the header token: xyz-your-token e.g. https://api.mycasavi.com/contacts

Pagination

All GET request collections have the below three attributes that define the number of objects, the current page and the total pages:

• "count": 67,

• "page": 0

• "pageCount": 3

{
    "count": 67,
    "page": 0,
    "pageCount": 3,
    "content": [
        {
            "id": "235655-43",
            "internalId": 123456,
            "title": null,
            "salutation": null,
            "firstName": null,
            "lastName": null,
            "companyRole": null,
            "email": null,
            "telephone": null,
            "mobile": null,
            "fax": null,
            "website": null,
            "street": null,
            "postalCode": null,
            "city": null,
            "country": null,
            "company": "blabla KG",
            "isRegistered": false,
            "preferredWayOfContact": "ONLINE"
        },
...

IDs in Casavi

Casavi has two types of IDs:

• External IDs (this is the id field in the API)

• Internal IDs (this is the internalId field)

The external ID can come from a third party system and is used in all API calls when an id has to be provided (e.g. getContactById expects the external ID, or when creating a post the external staff id has to be provided for the field authorId)