...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Overview
This guide is a quick reference that lists the steps for accessing the customer information of the currently logged in user. In USTA parlance, this is 'Bound' access. In this mode, the customer UAID is bound to the session under which the user has logged in to USTA.com. The token will restrict access to only data for this one UAID.
Integrating your application with USTA.com is easy. You can use any programming language or tool that supports HTTPS communications.
Me Construct
When working in Bound mode, 'me' represents the only customer to which you will have access to data. In other words, data that is about the logged in user.
Before Development
Before you begin development of your browser-based application, contact USTA to discuss what data you will need to access from USTA. Credentials will be issued for use to connect via HTTP.
...
- Stage (preproduction)
- Prod
Building Your Application
The following is a quick guide for accessing bound customer data. More on the bound mode can be found on the API Reference page.
It should be noted that the best use of this API is within the context of a browser-based application. Because the customer UAID is bound to the token, it is safe to store in a cookie.
JanRain Test Account
For the purpose of testing, we have created a dummy Janrain client id for use against the non-prod platform.
| Field | Value |
|---|---|
| client_id | afwu4zrn4caebfaf9d375vb5tvee5es5 |
| secret | Usta@1234 |
Step 1: Retrieve a Identity Token
The USTA bound access model is secured via the Janrain Identity Service. You must pass in your unique email corresponding to the USTA account for which you would like to retrieve customer information. Please note that the identity must pre-exist at Janrain before the call is made in order to authenticate and receive an identity token. The UAID associated with the identity will be the only identity for which you will be able to retrieve data.
If the email address does not exist at Janrain, there is no customer information to retrieve from USTA.
Headers
This API call uses Basic Authorization. Use the supplied client_id and secret to generate a Basic Authentication token. There are many online generators you can use for testing. One is here.
| Key | Value |
|---|---|
| Content-Type | application/x-www-form-urlencoded |
| Cache-Control | no-cache |
HTTP Call
This is the API call. Janrain only has two environments. Please note the difference in base urls:
Test: https://usta-dev.us-dev.janraincapture.com
Prod: https://usta-prod.us.janraincapture.com
Data/Payload
You must use the client_id and currentPassword assigned by USTA. The signInEmailAddress is your unique user identity at Janrain.
...
| Key | Value |
|---|---|
| client_id | <YOUR ASSIGNED JANRAIN CLIENT ID> |
| signInEmailAddress | <YOUR UNIQUE JANRAIN EMAIL ADDRESS> |
| currentPassword | <YOUR JANRAIN PASSWORD> |
| flow | standard |
| flow_version | 20161114171439489756 |
| redirect_uri | http://localhost |
| response_type | token |
| form | signInForm |
| locale | en-US |
Result
The important info returned from this call are the following:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"capture_user": {
...
},
"sso_code": "cb5730b0a4bcccdd",
"stat": "ok",
"access_token": "y5udk6hrb7ytqh5n"
} |
Example
This example uses CURL from the command line.
| Panel |
|---|
curl -X POST -d 'client_id=afwu4zrn4caebfaf9d375vb5tvee5es5&flow=standard&flow_version=20161114171439489756&locale=en-US&redirect_uri=http://localhost&response_type=token&form=signInForm&signInEmailAddress=jmeterTesting2@mailinator.com¤tPassword=Usta@1234' 'https://usta-dev.us-dev.janraincapture.com/oauth/auth_native_traditional' |
Step 2: Retrieve a JWT Token
This API calls the USTA OAuth Service to retrieve a JWT token that will be used to define the scope of permissions for future calls. Please note that if you are working within the context of a browser application, this token will be visible to users and could be used for subsequent calls. This is the equivalent of establishing a durable session.
Headers
This API call uses Basic Authorization. Use the supplied client_id and secret to generate a Basic Authentication token. There are many online generators you can use for testing. One is here.
| Key | Value |
|---|---|
| authorization | 'Basic [SUPPLY YOUR GENERATED BASIC AUTHENTICATION TOKEN]' |
HTTP Call
This is the API call. Please note the difference in base urls:
Test: https://stage-services.usta.com
Prod: https://services.usta.com
Result
The important info returned from this call are the following:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"access_token": "eyJh...,
"token_type": "bearer",
"expires_in": 43199,
"scope": "safeplay:status safeplay:details",
"client_name": "ClubBling",
"jti": "7b5f8ede-bbc1-4b2b-b127-a6f0e9dfb8cd"
} |
Example
This example uses CURL from the command line.
| Panel |
|---|
curl -X POST |
Step 3: Perform API Operations Using JWT Token
Once you have a JWT token, you can begin calling Bound API calls. Remember that the customer UAID is bound to the token, and only data associated with that UAID can be retrieved in Bound mode.
For instance, you can retrieve your Customer Profile information using the following API call: https://stage-services/v1/customer/me
Headers
| Key | Value |
|---|---|
| Content-Type | application/json |
| authorization | 'Bearer ZTc2ZGQxZWItZjVjMC00MDFiLWFjYTktZWYxZGRlNTcyYzg4OkhOOUU2U2ovdmtWUWEyR2pKYUxBSDF4WndWTzN0dHZWQmJRQnpRaVlpbWc1RWFvVVJ5bUVhTzc4SVRtNVh5NjQzSUo0UThTcHpTNXQ2c2Jz' |
Result
The result shows the account profile for the user associated with the email id requested in the Janrain token in Step 1.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"uaid": "2017492001",
"firstName": "bat",
"lastName": "man",
"dateOfBirth": "2018-02-11",
"gender": "DND",
"wheelchairPlayer": false,
"emails": [
{
"emailAddress": "bat.man430@mailinator.com"
}
],
"addresses": [
{
"id": "1568772805481",
"isPrimary": true
}
]
} |
Example
This example uses CURL from the command line.
...