Integration Guide¶
To gain full access to Sharecare APIs, you will need an API key; however, if you would like to explore our APIs without an API Key and see a live example response
- Click "Try it out" then "Execute" without changing any values within one of our Open API specifications
- Execute our curl examples without alteration within a terminal
To get an API key and gain full access to Sharecare APIs see Customer Onboarding
API Key Usage¶
All API requests require an X-API-Key header with the value of your API Key.
Protect your API Key!
Prioritize the security of your API keys and avoid sharing them to prevent unauthorized access and potential misuse
Store all keys in a private and protected location
Never check API keys into a code repository
Environments¶
Sharecare maintains three externally accessible environments
| Environment | Value | Description | Examples |
|---|---|---|---|
| Prod | Production | https://auth.shareacre.com | |
| UAT | uat | Client User Acceptance Testing Typically used to validate beta client go lives if the client has required that step in the process. Addtionally this environment is used for demo purposes to clients. |
https://auth.uat.shareacre.com |
| Stage | stage | Partner Integration and Testing Initial integration environment for the partners to develop against Sharecare APIs. |
https://auth.stage.shareacre.com |