CINC API

Introduction

The CINC API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The CINC API provides access to homeowner information, association information, homeowner transactions, vendor information, etc. We are always working on expanding our API for our customers.

The API swagger definition can also be viewed on your CINC accounting portal under https://yourcustomerdatabase.cincsys.com/api/swagger

What is a REST API?

An API is an application programming interface. In short, it is a set of rules that lets programs talk to each other, exposing data and functionality across the internet in a consistent format.

REST stands for Representational State Transfer. This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term "REST API" they are generally referring to an API accessed via HTTP protocol at a predefined set of URLs.

These URLs represent various resources, i.e. any information or content accessed at that location which can be returned as JSON, HTML, audio files, or images. Often, resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT, and DELETE.

CINC API Summary

The CINC API is currently running V1 and provides our customers with valuable endpoints to update and get information. Details can be seen under the API Endpoints menu. Here is a summary of what is available today:

Homeowners

  • Look up information on homeowners

  • Update information on homeowners

  • Work with address information

  • Work with homeowner transactions

  • Work with correspondance types and templates

  • Work with posting charges

ACC Information

  • Get detailed ACC information and types

  • Create ACC information

Vendor Information

  • Retrieve and update vendor information

Association Information

  • Get detailed association information

Other

  • Work with collections

  • Retrieve documents

  • Get detailed call logs

  • Work with aged balances

All API documentation will list needed parameters and response bodies.