February 2024 Update
We are excited to announce that the ForceFrame API endpoint is now available.
With all region-based API endpoints now available, our integration partners will have until 31 March 2024 to transition to this new infrastructure and decommission the legacy endpoints.
|
| ||
|
Current URL (being deprecated): https://dbapi.valdperformance.com/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-externalforceframe.valdperformance.com/swagger/index.html | |
| US East | https://prd-use-api-externalforceframe.valdperformance.com/swagger/index.html | |
| EU West | https://prd-euw-api-externalforceframe.valdperformance.com/swagger/index.html | |
Please carefully review these updates, and read our API Best Practices Guide for tips on integrating your systems with VALD using these new region-based endpoints.
November 2023 Update
As of November 2023, we are implementing new changes that will affect all VALD external APIs.
When attempting to access a VALD tenant's data, you must now use the tenant's corresponding region-based API URL.
Historically, VALD external APIs have been exposed behind a geographically routed traffic load balancer that will soon be decommissioned and replaced with region-based URLs.
All tenant data will still be accessible using the original scope until the load balancer is decommissioned.
All changes mentioned in this update are live and available to you. We suggest that you make these changes as soon as practical to ensure that your API integrations continue to work. We will send further communication to affected parties in the near future with a definitive changeover date.
Breaking changes
This release will include updates to region-specific addresses in addition to other important updates. Use the links below to read details regarding each change.
Future updates to come
This document will be updated in future once we have ForceFrame API live and available for use.
Where do I begin?
- You must know the tenant ID for any clients you wish to retrieve data for.
For steps on how to obtain a tenant ID please use this article. - You must know which region-specific API to use between:
- Australia (East)
- United States (East)
- Europe (West)
Please reach out to support@vald.com for assistance if you are unsure.
For best practice and tips on integrating your systems with VALD, please refer to our API Best Practices guide.
DashBord API changes
VALD DashBord API has historically been used to retrieve tenant (Team), profile (Athlete), NordBord and ForceFrame (aka GroinBar) data.
As part of our continued commitment to providing functionality and improvements to our APIs, we have made the decision to decommission DashBord API and replace it with scope-specific APIs to enable us to improve the quality, performance and value of the offerings.
Due to DashBord API being decommissioned, the api.dashbord OAuth Scope is also being deprecated - see OAuth Scope section for more details.
The following table lists the endpoints available on v2018q3 of DashBord API, their replacement API and the status.
| Existing DashBord API Endpoint | New API | Status |
| /teams | External Tenant | Available |
| /teams/{tenantId} | External Tenant | Available |
| /teams/{tenantId}/groups | External Tenant | Available |
| /teams/{tenantId}/athletes | External Profile | Available |
| /teams/{tenantId}/athletes/externalid | External Profile | Available |
| /teams/{tenantId}/athletes/{profileId} | External Profile | Available |
| /teams/{tenantId}/athletes/{profileId}/externalid | External Profile | Available |
| /teams/{tenantId}/tests/{page} | NordBord | Available |
| ForceFrame | Available | |
| /teams/{tenantId}/athletes/{profileId}/tests/{dateFrom} /{dateTo}/{page} |
NordBord | Available |
| ForceFrame | Available | |
| /teams/{tenantId}/tests/{dateFrom}/{dateTo}/{page} | NordBord | Available |
| ForceFrame | Available | |
| /teams/{tenantId}/athletes/{profileId}/tests/{dateFrom} /{dateTo}/{page} |
ForceFrame | Available |
| /teams/{tenantId}/groups/{groupId}/athletes | N/A | Deprecated |
| /teams/{tenantId}/groups/{groupId}/athletes/externalid | N/A | Deprecated |
| /teams/{tenantId}/athletes/{profileId}/tests/{page} | N/A | Deprecated |
Region-specific URL changes
|
Current URL (being deprecated): https://smspextapi.valdperformance.com/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-extsmartspeed.valdperformance.com/index.html | |
| US East | https://prd-use-api-extsmartspeed.valdperformance.com/index.html | |
| EU West | https://prd-euw-api-extsmartspeed.valdperformance.com/index.html | |
|
Current URL (being deprecated): https://dynamoextapi.valdperformance.com/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-extdynamo.valdperformance.com/index.html | |
| US East | https://prd-use-api-extdynamo.valdperformance.com/index.html | |
| EU West | https://prd-euw-api-extdynamo.valdperformance.com/index.html | |
|
Current URL (being deprecated): https://fdapi.valdperformance.com/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-extforcedecks.valdperformance.com/index.html | |
| US East | https://prd-use-api-extforcedecks.valdperformance.com/index.html | |
| EU West | https://prd-euw-api-extforcedecks.valdperformance.com/index.html | |
|
| ||
|
Current URL (being deprecated): https://dbapi.valdperformance.com/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-externalnordbord.valdperformance.com/swagger/index.html | |
| US East | https://prd-use-api-externalnordbord.valdperformance.com/swagger/index.html | |
| EU West | https://prd-euw-api-externalnordbord.valdperformance.com/swagger/index.html | |
| EXTERNAL PROFILE | ||
|
Current URL (being deprecated): https://dbapi.valdperformance.com/index.html https://extprofapi.valdperformance.com/swagger/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-externalprofile.valdperformance.com/swagger/index.html | |
| US East | https://prd-use-api-externalprofile.valdperformance.com/swagger/index.html | |
| EU West | https://prd-euw-api-externalprofile.valdperformance.com/swagger/index.html | |
| EXTERNAL TENANT | ||
|
Current URL (being deprecated): https://dbapi.valdperformance.com/index.html | ||
| New region-specific URLs | ||
| AU East | https://prd-aue-api-externaltenants.valdperformance.com/swagger/index.html | |
| US East | https://prd-use-api-externaltenants.valdperformance.com/swagger/index.html | |
| EU West | https://prd-euw-api-externaltenants.valdperformance.com/swagger/index.html | |
OAuth Scope changes
The api.dashbord and api.forcedecks OAuth Scopes are being deprecated.
Where possible, an OAuth Scope should not be supplied in the Access Token Request. Where the tool or framework you are using requires an OAuth Scope, you must now use api.external.
Query parameter requirements for retrieving tests
When retrieving tests, it will now be mandatory to supply the last point in time you successfully retrieved tests for the tenant.
This would usually be done with a query parameter modifiedFrom or modifiedFromUTC.
Please see our API Best Practices guide for more information.
Comments
0 comments
Please sign in to leave a comment.