Page Comparison

...

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.

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.

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 a credentials token.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

Verb	URL
POST	https://usta-[ENV].us-dev.janraincapture.com/entity?type_name=user&access_token=xzx985uf9kp3dczv&uuid=1d1da5b6-a411-462c-8b63-2f87c17b7ab5

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>
currentPassword	<YOUR JANRAIN PASSWORD>
signInEmailAddress	<YOUR UNIQUE EMAIL ADDRESS>
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:

jti: token that will be passed in subsequent calls

exprires_in: the Time To Live of the tokenaccess_token: The identity token representing the logged in user.

Code Block

language	xml
title	Result of https://usta-dev.us-dev.janraincapture.com/oauth/auth_native_traditional

{
  "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=mfxx6uef2wjfjyrhav6gjn66srgt4zbp&flow=standard&flow_version=20161114171439489756&locale=en-US&redirect_uri=http://localhost&response_type=token&form=signInForm&signInEmailAddress=jmeterTesting2@mailinator.com&currentPassword=Usta@1234' 'https://usta-dev.us-dev.janraincapture.com/oauth/auth_native_traditional'

Step 2: Retrieve

...

a JWT Token

This API call is used to retrieve a 'thumbs up/thumbs down' assessment of whether the provider is SafePlay approved. This result is calculated based on the following criteria:

Legal Agreement Date
NCSI Status
SafeSport Completion
SafeSport Expiration

Headers

...

Data/Payload

Email is used as the unique identifier for looking up SafePlay status.

...

Result

The result is calculated summary status of true/false.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.

The scope restricts access as defined by USTA at the time of client_id setup.

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

Verb	URL
POST	https://[stage-]services.usta.com/v1/oauth/token?grant_type=janrain_token

Result

The important info returned from this call are the following:

jti: token that will be passed in subsequent calls

exprires_in: the Time To Live of the token

{ "isApproved": false

Code Block

language	xml
title	Result Of of https://stage-services.usta.com/dev/v1/approval/isApproved

oauth/token?grant_type=client_credentials

{
    "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
'https://devstage-services.usta.com/dev/v1/approval/isApproved
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJzYWZlcGxheTpzdGF0dXMiLCJzYWZlcGxheTpkZXRhaWxzIl0sImV4cCI6MTU2OTM3OTI1OSwiY2xpZW50X25hbWUiOiJDbHViU3BhcmsiLCJqdGkiOiJjNWI0ZWNlYS1hNGQwLTQ4NmMtOGFiYi0xYzE3NmJkYTM0NGUiLCJjbGllbnRfaWQiOiJlNzZkZDFlYi1mNWMwLTQwMWItYWNhOS1lZjFkZGU1NzJjODgifQ.dWri48wRO4pbYZaZHseX6u8fRqW8yrOGr4YwpQ_IlSX4QVGPA7QHxW2wf3aOuXsXSfKYow9W7fXyNtrktlgq8i6_ZcTFPNSpEmcMnMM5gDByDbc0gEklPQ0xm8dh1GuW80SKjuFUroEieRx2T0hlxFMnoV79po2l4UsVQ7VCHSUnA498hIZnUOZlFbUltMeZS0POCLhOb41VC0Mbqkgk4QwEKtkZRLcVGCbINhlEsgOvA5TPgTVDEAi1Wt3N1O7xN5PmojNRpI8Rg0Ti2LE18TZ5JHVBxD7W3140glQURG_oRdkLNCK_czJhxI1g1PVpHjXkyM3O_Yv3RVU5_Gly3Qoauth/token?grant_type=janrain_token'
-H 'Content-Type: application/json'
-H 'cache-control: no-cache'
-d '{
"email": "provider@mailinator.com"
}'

Step 2: Retrieve Approval Details Using JWT Token (Optional)

...

Authorization: Basic ZTc2ZGQxZWItZjVjMC00MDFiLWFjYTktZWYxZGRlNTcyYzg4OkhOOUU2U2ovdmtWUWEyR2pKYUxBSDF4WndWTzN0dHZWQmJRQnpRaVlpbWc1RWFvVVJ5bUVhTzc4SVRtNVh5NjQzSUo0UThTcHpTNXQ2c2Jz'

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'

...

Key	Value

email	provider@mailinator.com

Result

The result shows the current values associated with the inputs:

Legal Agreement Date
NCSI Status
SafeSport Completion
SafeSport Expiration

the account profile for the user associated with the email id requested in the Janrain token in Step 1.

Code Block

language	xmljs
title	Result Of https://stage-services.usta.com/dev/v1/approvalcustomer/detailsme

{
    "legalAgreementAcceptDateuaid": "2019-05-142017492001",
    "legalAgreementExpireDatefirstName": "2021-05-14bat",
    "legalAgreementStatuslastName": "Acceptedman",
    "ncsiCheckTimestampdateOfBirth": "20192018-06-28T12:03:0402-11",
    "ncsiExpiryDategender": "2019-06-19DND",
    "ncsiCheckStatuswheelchairPlayer": "Expired"false,
    "safeSportCompleteDateTimeemails": "2018-10-25T10:56:07", [
        {
            "safeSportExpiryDateemailAddress": "2020-10-25"bat.man430@mailinator.com"
        }
    ],
    "safeSportStatusaddresses": "COMPLETE", [
        {
            "safePlayStatusid": "EXPIRED1568772805481",
    "safePlayStatusDisplayValue": "Expired"        "isPrimary": true
        }
    ]
}

Example

This example uses CURL from the command line.

Panel

curl -X POST GET \
https://devstage-services.usta.com/dev/v1/approvalcustomers/details me \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9eyJhb..eyJzY29wZSI6WyJzYWZlcGxheTpzdGF0dXMiLCJzYWZlcGxheTpkZXRhaWxzIl0sImV4cCI6MTU2OTM3NzM5OCwiY2xpZW50X25hbWUiOiJRQSIsImp0aSI6ImI4ZmVkMTBkLTliMWItNDU2My1iZDRjLWE1ZDUyMjVhYWYxOSIsImNsaWVudF9pZCI6InFhX3NwYWFzIn0. fbmasURVRWmbUh-vx4kJJvXwYGUzh_Jc7cOgEpDxyUoOkPGBsagWUixEzMmiZylo7ZywPN5x9cTBLGon9w7aQ2BzgsfQJLqL4rmVLf9YEspo9WTSXq0tqhlV8RlzVJhCoSCIfk4qS_gztdnvTdX7a0Im64IL8At_oEMcCspnmHJJzu9cpuUQn-ByJV3xzgYTY9ZibxG_g2z4SwnpPznB0kTUw-F1_pxE8nlN_Y0-_rPt-S-VGLIXF72rEeyQhgIbAapK6Cli9Bcy1-kf992f2nDOkiL3ygfwqtsObQ5AnxNwwenVhLgWZjoh6XFob0lEHwRmBD4qJAofbFm5yZcEqg\
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"email": "broderick@mailinator.com"
}'

Versions Compared

Old Version 4

New Version 5

Key

Overview

Before Development

Building Your Application

Step 1: Retrieve a Identity Token

Headers

HTTP Call

Data/Payload

Result

Example

Step 2: Retrieve

a JWT Token

Headers

Data/Payload

Result

Headers

HTTP Call

Result

Example

Step 2: Retrieve Approval Details Using JWT Token (Optional)

Step 3: Perform API Operations Using JWT Token

Headers

Result

Example

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

<span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-0">[data-colorid=</span>

<span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-25">}</span>

Overview

Before Development

Building Your Application

Step 1: Retrieve a Identity Token

Headers

HTTP Call

Data/Payload

Result

Example

Step 2: Retrieve

a JWT Token

Headers

Data/Payload

Result

Headers

HTTP Call

Result

Example

Step 2: Retrieve Approval Details Using JWT Token (Optional)

Step 3: Perform API Operations Using JWT Token

Headers

Result

Example