Skip to content
Smartlife Docs
FR

API developer path

  1. Home
  2. Documentation
  3. Learning paths
  4. API developer path
SmartLife Properties Brought to you by SmartLife Properties · We turn your ideas into reality

Connect your tools to the platform

Get an OAuth2 token, read your projects and rentals, change the status of a project and fix the most common API errors.

  • Developers and integrators
  • 6 steps
  • About 30 minutes

Start with step 1: each article takes you to the next one.

Start the learning path Download the path as PDF

  1. Authenticate

    1. Step 1 : Get an OAuth2 token

      Overview of the API and of the two OAuth2 authentication flows available to get an access token.

  2. Read data

    1. Step 2 : List your projects

      Documentation of the GET /api/projects/list endpoint: required scope, response structure, example call and built-in tester.

    2. Step 3 : Read a project's data

      Documentation of the GET /api/project/{project_id}/data endpoint: status and aggregated rental data of a single project, with its access rights.

    3. Step 4 : Get the rentals summary

      Documentation of the GET /api/rentals/summary endpoint: required scope, response structure, example call and built-in tester.

  3. Write and troubleshoot

    1. Step 5 : Change a project's status

      Documentation of the PATCH /api/project/{project_id}/state endpoint: change the status of a project through the OAuth2 API.

    2. Step 6 : Understand common errors

      Table of the error codes returned by the API (401, 403, 404, 422) and how to fix them.