Customer Onboarding¶
This guide covers the necessary steps needed to obtain an API Key and full access to Sharecare API's and to embed Sharecare Embeddable Features in your application.
Note
You can still explore Sharecare API's with the Try it Out feature. Sharecare Embeddable Features require an API Key.
Setup¶
The following items must be setup by Sharecare
| Item | Description | Example |
|---|---|---|
| Provider ID | The Oauth Provider ID, one per partner. | partner |
| Domains | The Domains that can issue an Oauth Authorization request by environment (stage, uat, production) | app.sharecare.com app.uat.sharecare.com app.stage.sharecare.com |
| Request Volume | 1. Determine the number of 'requests per second' required for each environment. 2. Sharecare will submit a scale request based on the decided request volume. |
The following items will be provided after the initial setup by Sharecare
| Item | Description | Example |
|---|---|---|
| Sponsor ID | Generated as part of sponsor creation process. | CM_GENERA |
| API Key | API key for API access. Keys are unique and associated with a partner applicaiton. Keys are provided as part of partner integration process. |