4. Versioning

To maintain system stability while enabling significant feature updates, CentriCare APIs employ Path Versioning. Every request sent to the server must explicitly include the API version number within the URL.

Base URL Format

https://api.centricare.cloud/v{major_version}/

Example Request

curl -X GET "[https://api.centricare.cloud/v1/patients](https://api.centricare.cloud/v1/patients)"

Deprecation Policy

Updating integrations takes time; therefore, when a new major version (e.g., v2) is released, the previous version (v1) will not be deprecated immediately. A grace period will be provided to allow sufficient time for migration.

However, to ensure users are aware that an API version has been deprecated, specific HTTP Response Headers will be included in every response served by that version.

Warning Header

The following headers convey API deprecation details:

Deprecated Version Response Example

Although a version is marked as deprecated, incoming requests will continue to process successfully until the specified Sunset date is reached.

Contoh Respons:

HTTP/1.1 200 OK
Content-Type: application/json
Deprecation: true
Sunset: Fri, 01 Jan 2027 23:59:59 GMT
X-API-Latest-Version: v2
Warning: 299 - "API version v1 is deprecated and will be removed on Jan 1, 2027. Please upgrade to v2."

{
  "data": [
    {
      "_id": "01H9A3XBCDEFG",
      "name": {
        "first": "Budi",
        "last": "Santoso"
      }
    }
  ]
}