Getting Started

Welcome to the API developer portal, Y-USA STUDIO. This API guide provides integration documentation on how to develop and integrate your applications with Y-USA STUDIO's APIs. Y-USA STUDIO APIs are designed around REST.

Partnering with Approved Vendors

Y-USA would like to partner with approved vendors working with our movement YMCAs in order to evolve the Digital Transformation product offerings. Some of our digital products require special access to vendor APIs in order to help create a great user experience for our YMCA's members. Our aim is to have a uniform specification to access vendor APIs for member, program/classes, and/or video information. The APIs below are not active or usable but should serve as a guide for setup in your environment and by your development team.

Authentication

YMCA APIs let you define the following authentication types for an API:

Basic Authentication

Member Validation and Information

Member Information API endpoint to be designed and exposed by Vendors using Basic authentication.

Note: Because base64 is easily decoded, Basic authentication should only be used together with other security mechanisms such as HTTPS/SSL.

API Endpoint

POST https://{base_url}/api/{version}/authorize/member

Programs / Classes

Program / Class API endpoint to be designed and exposed by Approved Vendors using Basic authentication.

API Endpoint

GET https://{base_url}/api/{version}/programs/getclasses[?startDate=startDate][&endDate=endDate][&memberId=memberId]

OAuth 2.0

Get Authorization Token

Y-USA prefers to use OAuth 2.0 Authorization whenever possible, although we will use Basic Auth when vendors can't support OAuth 2.0. The proposed setup we would like implemented to generate an authorization token. This token will be used to validate and retrieve member and program / class information.

API Endpoint

POST https://{base_url}/api/{version}/oauth/token

Member Validation and Information

Member Information API to be designed and exposed by Approved Vendors using OAuth 2.0 authentication.

API Endpoint

POST https://{base_url}/api/{version}/authorize/member

Programs / Classes

Classes API to be designed and exposed by Approved Vendors using OAuth 2.0 authentication.

API Endpoint

GET https://{base_url}/api/{version}/programs/getclasses[?startDate=startDate][&endDate=endDate][&memberId=memberId]