Your Client ID and Client Secret will be provided to you separately from this document. You will also be provided with an Account ID and Facility ID that you may use to begin testing the API.

The GraphQL Endpoint URL below will allow you to access the API as well as the GraphQL playground where you can test all queries, mutations, inputs, and outputs that are required to interact with the Evolus Rewards API:

https://4xjn5ui0hj.execute-api.us-east-1.amazonaws.com/staging/graphql

Note: When your integration is production ready, you will be provided with a new endpoint specifically for production.

You can generate an access token by executing the auth query using your Client Id and Client Secret. If you are using the GraphQL playground add these to the "QUERY VARIABLES" section:

QUERY VARIABLES

{ 
   "input ": { 
     "clientId ":  "YOUR_CLIENT_ID ", 
     "clientSecret ":  "YOUR_CLIENT_SECRET ", 
     "grantType ":  "client_credentials ", 
     "scope ": null 
  }
}

All other queries and mutations will require an Authorization header using the accessToken from the auth query response.

If you are using the GraphQL Playground add your headers in the "HTTP HEADERS" section:

HTTP HEADERS

{ 
   "Authorization ":  "Bearer YOUR_ACCESS_TOKEN_HERE"
}

This section is intended to help you understand the general flow on the check in process and the required queries and mutations.

1. Lookup Account

Check the Account with the getAccountOptInDetails query to make sure it's eligible for Evolus Rewards.

• If status = ACTIVE => proceed to Step 2 - Lookup Profile
• If status = INACTIVE => the account is not eligible for Evolus Rewards

2. Lookup Profile

Check the status of the consumer's profile using the getProfileStatus query.

• If not isEnrolled => call createProfile mutation and wait for consumer to finish profile. Then proceed to Step 3 - Lookup Reward
• If isEnrolled but not isCompleted => call resendEnrollmentLink mutation and wait for consumer to finish profile. Then proceed to Step 3 - Lookup Reward
• If isBlackListed => display a message about the carrier not being support
• If isEnrolled and isCompleted => proceed to Step 3 - Lookup Reward

3. Lookup Reward

After the user has completed their profile or if they have an existing completed profile call the getActiveReward query to get the status of the consumers active reward.

• If eligibilityStatus is EXPIRED => consumer's reward is expired, call the createReward mutation to make a new reward.
• If eligibilityStatus is EXPIRED_IN_GRACE_PERIOD => proceed to Step 4 - Lookup Injector
• If eligibilityStatus is NOT_YET_ACTIVE => consumer's reward is not available yet, cannot check in consumer
• If eligibilityStatus is ELIGIBLE => proceed to Step 4 - Lookup Injector

4. Lookup Injector

Call the getInjectors query to determine if a facility has injector specialists linked to their account and display the list to the user.

• Store the user selected injector and proceed to Step 5 - Check In
• Optionally store a newly created injector in memory and proceed to Step 5 - Check In

5. Check In

Create a new check in using checkIn mutation, and conditionally store the injector that is responsible for the consumer's treatment.

• If an injector was selected/created => create check in with injector, and proceed to Step 6 - Send Secret
• If an injector was not selected/created => create check in without injector, and proceed to Step 6 - Send Secret

6. Send Secret

Send the consumer a secret phrase using the sendSecret mutation. The secret phrase will be verified during Step 7 - Redeem Reward.

• If consumer not isBlackListed
  • AND if enrollment method is SMS sendSecret with deliveryMethod = SMS
  • AND if enrollment method is EMAIL sendSecret with deliveryMethod = EMAIL
• If consumer isBlackListed, sendSecret with deliveryMethod = TEXT_TO_VOICE

7. Redeem Reward

Validate the secret phrase and finalize the check in process using the redeemReward mutation.

• If consumer does not successfully answer the secret phrase => allow guessing 3 total times max
• If consumer does not successfully answer the secret phrase, and exceeds 3 max attempts => resend secret phase with sendSecret mutation.
• If consumer successfully answers the secret phrase => check in complete

You may find the following links useful:

• https://graphql.org/learn/ - A general guide for developers new to GraphQL
• https://docs.github.com/en/graphql/guides/introduction-to-graphql - A short guide if you're new to using GraphQL from Github.
• https://docs.github.com/en/graphql/guides/forming-calls-with-graphql - A longer guide to forming calls with GraphQL. Useful if you're coming from a REST background.
• https://www.postman.com/ - A great tool for building and using APIs

Any questions can be directed to:

• michael.strieleman@kingsmendv.com
• neal.lambert@kingsmendv.com