Welcome to AlayaCare's Resi REST API Integration Guide!

This comprehensive resource is designed to assist developers in seamlessly integrating our services into their applications and systems. Whether you're looking to leverage our platform's capabilities for data retrieval, authentication, or any other functionality, this guide provides step-by-step instructions, sample code snippets, and best practices to ensure a smooth and efficient integration process.

Prerequisites

You will require:

  • AlayaCare Resi account
  • UserName
  • Password
  • Authorization DBID
  • REST client such as Postman

Authentication

AlayaCare RESI APIs use Basic Authentication.

Important: In AlayaCare RESI users can be granted access to multiple organizations. Each organization is a separate database in our SaaS environment. You may have access to a Production organization and a Training organization. Therefore, you need to specify the organization you are trying to access via "Authorization-DBID" header in the Login API request.

REST Client Configuration

If you are using a REST client (e.g. Postman), ensure the following parameters are configured:

Basic Authentication Configuration

Authorization DBID Header Configuration

Once you are authenticated, you will receive a token in the response.

Sample Authentication Response

You will need to use this token in the header of all subsequent requests.

Token Usage in Subsequent Requests

API Documentation

API specifications are documented and available online at https://residential.alayacare.com.au/api/Help/OpenAPI

  • Client Extensions read
  • Client Extensions write

Postman collection will be provided on request.