AlayaCare
External API and integration documentation
Product Documentation
- External API Guide
- Flat File Guide
- Intake API Guide
- SSO Guide - DEPRECATED
- Technical Architecture
- SQS Message Specifications
Release Notes
Swagger Updates
Latest specification version. Dates in the future indicate an upcoming AlayaCare release; specifications will be public but “unpublished” until that date.
| Date | Document | Latest Version |
|---|---|---|
| 2019-08-06 | Client Swagger | 1.0.5 |
| 2020-03-06 | Employee Swagger | 1.0.6 |
| 2020-02-11 | Scheduler Swagger | 1.0.7 |
| 2019-08-06 | Tasks Swagger | 1.0.1 |
| 2019-08-06 | Files Swagger | 1.0.0 |
| 2019-08-06 | Accounting Swagger | 1.0.4 |
| 2019-12-10 | Clinical Swagger | 1.0.3 |
| 2020-02-11 | Employee Skills Swagger | 1.0.0 |
| 2020-05-04 | Employee Unavailabilities Swagger | 1.0.0 |
| 2023-03-17 | Medication Swagger | 1.0.0 |
| 2024-11-21 | Forms Swagger | 1.0.0 |
| 2024-11-21 | Tasks v2 Swagger | 1.0.0 |
Documentation Updates
Latest documentation updates.
| Date | Document | Notes |
|---|---|---|
| 2020-05-04 | External API Guide | Added Employee Unavailabilities Swagger reference |
| 2020-03-24 | Flat File Guide | Added Flat File Workflow Overview section |
| 2019-07-11 | Intake API Guide | Added to site |
| 2020-02-06 | SSO Guide | Updated metadata requirements and examples |
| 2019-07-11 | Technical Architecture | Added to site |
| 2020-07-09 | SQS Message Specifications | Added Client Status history events |
| 2020-01-07 | Release Notes | AlayaCare Zendesk section for API release notes |
| 2020-02-05 | Data Warehouse and IPSec | Added to site |
| 2024-04-16 | Remove deprecated Data Warehouse and IPSec documentation | Removed from site |
| 2024-11-21 | SSO Guide | Deprecation of the legacy SSO Guide |