1curl -X POST https://api.partners.gympass.com/access/v1/validate \
2 -H 'Content-Type: application/json'\
3 -H 'X-Api-Key: ${YOUR_API_KEY}'\
4 -H 'X-Gym-Id: ${GYM_ID} \
5 -d '{"gympass_id":"XXXXXXXXXXXX"}'
Params
Field
Description
gympass_id
Required field. String, This is the user’s gympass_id with 13 digits, and the "value/option" will require previous check-in at the gym.
Headers
Field
Description
X-Gym-Id
Required field
This is the ID of the gym you’re setting up. Choose it according to the list of gyms you manage.
Content-Type
Required field
The Content-Type entity header is used to indicate the media type of the resource. Use always application/json
X-Api-key
Required field
The key is a string that is generated for you and identifies you and the gyms you are allowed to validate products for. To request yours, e-mail us at relacionamento@gympass.com.
Response
Example
1{
2"metadata":{
3"total":1,
4"errors":0
5},
6"results":{
7"user":{
8"gympass_id":"XXXXXXXXXXXXX"
9},
10"gym":{
11"Id": XXX,
12"product":{
13"Id": XXX
14"description":"XXXXXXX"
15}
16},
17"validated_at":"2020-02-19T18:00:53Z"
18}
19}
Response Body
Field
Description
User: { “gympass_id”: “XXXXXXXXXXXXX” }
This is the Gympass User id. You may use it to synchronize users that validated check-ins with your users base.
Gym: { “Id”: XXX }
This is the Gympass partner id. You may use it to identify each of your units in your Gympass validations reports.
These are the identifications of the validated product for a validated check-in. You may use it to identify the validated product for your staff in real time, just after the validation.
“validated_at”: “YYYY-MM-DDThh:mm:ssTZ”
This is the date and time of each check-in validation. You may use it for consultations by your staff in real time or as a data register in your system.
Use case: if you have a front desk staff, they could use the product information to give proactive orientation and offer them a better experience. |
Return Codes
HTTP Status
code
description
200 ok
404 not found
{"metadata": { "total": 0, "errors": 1 }, "errors": [ { "message": "Check-In not found in database", "key": "checkin.validation.notfound" }]}
The validation system couldn't find the user check in. Please ask the user to perform the check-in and try again.