Introduction
HuskyCare is software for care providers such as home nursing services, assisted living facilities and day care centers. It covers client records, care contracts, tour and shift planning, care documentation and billing.
Everything the HuskyCare web application does goes through one GraphQL API. You can use the same API to connect your own systems, for example to read clients and tours into a reporting tool or to create records from another application.
What you need
- A HuskyCare tenant. Your tenant name is the first part of the host name you use to open HuskyCare. For
https://example.huskycare.eu, the tenant name isexample. - An API key for that tenant. A tenant administrator creates it in HuskyCare. See Authentication.
- Familiarity with GraphQL and the OAuth2 client credentials grant.
Environments
| Environment | GraphQL endpoint | Token endpoint |
|---|---|---|
| Production | https://<tenant>.huskycare.eu/api/graphql | https://login.huskycare.eu/realms/<tenant>/protocol/openid-connect/token |
| Reference | https://main.huskycare.dev/api/graphql | https://login.huskycare.dev/realms/main/protocol/openid-connect/token |
Most customers use their production tenant. The reference environment runs the current development version of the API. The schema documentation on this site and the API Playground are built from it, so they can show fields that production does not have yet.
How this documentation is organized
- Authentication: create an API key, request a token, send it with each request.
- Making requests: endpoints, a first query, and conventions of the API.
- Errors: how the API reports failures and which ones your client should handle.
- Domains: the business areas of HuskyCare.
- API reference: generated from the schema. Each query and mutation lists the authorization features it requires; the authorization overview lists all features in one table.