What are the features provided in the API?

• Eligibility Check: this provides two endpoints. One is a minimal check that requires only name and zipcode, and returns a boolean result indicating whether or not one or more currently-eligible members have been found. The other requires more member details and performs a full eligibility check in Tivity Membership, returning specific member information. This full check is required before registering a member in a program or service.
• MealPlan Eligibility Check: this endpoint is similar to the full eligibility check above, but requires two additional fields -- Product and CostCenter. This endpoint performs the additional check of whether the member is eligible for post-discharge nutrition. If the member and plan are enabled for meals, then the type of plan and the number of meals remaining in this calendar year are calculated, then returned in the response body. This check is required before authorizing any meals through the Register Member endpoint.
• Register Member: this endpoint accepts the Tivity specific ids that were returned by the eligibility check along with the member details to add the member to the partners program or service. In the case of authorizing a meal that a member has been found to be eligible for, the CostCenter must be provided in the request body, and the PartnerMemberId field is interpreted as the meal plan order number. Each meal authorized must have a unique order number otherwise the endpoint simply updates the existing order record. The records created by this endpoint are used in calculating the number of meals remaining for the member in the current calendar year.
• Un-Register Member: this endpoint takes the same body that the Register Member requires. The purpose is to provide a mechanism to reverse any manual registration errors, or to cancel any meals that have been previously authorized and counted against the annual allowance, but that have not actually been taken.

How to authenticate API calls?

Tivity Health Partner API uses OAuth 2.0 to authenticate all API method calls. Client Credentials grant type is used to authenticate a client. Please follow below steps to access the API methods.

• Tivity Health will create the client_id and client_secret and register your account. This information will be securely communicated to you.
• Using the client_id and client_secret make a POST call to below endpoint to obtain an access token.
  https://partnerauth.tivityhealth.com/connect/token
• Finally, using the access token make the API call. Please make sure to set the Authorization HTTP header value as Bearer access_token
• Currently, the access token expires in 1 hour. You can also cache the access token if you're planning to make multiple calls within the 1 hour time frame.

How to use API calls?

• The first step is to call the authentication API and obtain an access token
• Once you have the access token, you can make a GET/POST call to the API by calling the below endpoint.
  https://partnerapi.tivityhealth.com/partnerapi/{method_name}
• To get more details on the API method calls, please visit API Docs
• You can also look at a sample example of how to use the API. Click here to view it.

Have any more questions?