Wellhub is a SaaS platform designed to enable companies to extend the fitness and wellness programs to their employees as a wellness benefit. Employees are able to access the largest global network of gym partners fitness facilities and activities at a significantly reduced price.
\nThis document covers the process of using the Wellhub Booking API to create and edit classes for your gym or studio as well as the booking process for a Wellhub user.
\nOur Booking API makes it possible to add classes and schedule them on to the Wellhub platform. This is required for a successful integration with Wellhub as it allows for our partners Class Inventory to be listed and bookable on the Wellhub Ecosystem.
\nWith our Booking API, you can leverage a seamless flow integrating your class system with our platform, allowing an easier and integrated process for booking.
\nWith the help from our Webhooks we can then update our partners systems schedule automatically once a Wellhub user has made a booking via our platform. Once you create a class on your system, Wellhub receives the information via the Booking API and our Webhooks do all the work in maintaining synchronised information between both applications once a Wellhub user has made a booking via our platform.
\nWellhub has a check-in process that ensures that partners are able to validate legitimate Wellhub subscriber visits to their facilities.
\nCheck-in is a core part of the Wellhub customer UX and is essential for the correct payment of completed check-ins to our partners.
\nFor this reason;
\nCheck-ins must be done through the Wellhub app for all visits by subscribers
\nCheck-ins must be validated
\nOnce the user performs a check-in on the Wellhub app your system can use our Access Control API to confirm it.
\nA check-in has an expiration time, which means that it must be validated in this given interval. When called, this API needs to send the gympass_id, which is the user’s unique number.
\nThe Wellhub webhooks will notify you when specific events are triggered. This notification is a HTTP POST request to your registered URL.
\nThe booking workflow relies on the use of 4 Webhooks:
\nbooking.requested - Triggered whenever a new booking request is made.
\nbooking.cancelation - Triggered whenever a user cancels a previous booked class.
\nbooking.LateCancelation - Triggered whenever a user cancels a previous booked class AND they cancelled outside of the approved window.
\n\n\nWe will required you to provide Wellhub with a Webhook handler for us to direct the Wellhub Webhooks to.
\n
Firstly lets get you set up with our API collection.
\n\n\nclick the \"Run in Postman\" button in the top right of this page to import our API collection
\n
![](\"https://run.pstmn.io/button.svg\")
\n\nTo be able to use this API Test collection you will require the following:
\nSystem ID
\nAPI Key
\nThe above will be provided to you by your Wellhub Technical Sales contact. Please reach out to them directly referencing \"Test Environment Credentials\"
\nThe Technical Sales team will produce and provide you with your credentials .
\nIn this guide you will learn how to:
\nPOST - Create - Create a class on the Wellhub Ecosystem.
POST - Slots - Schedule that class on the Wellhub Platform ready for booking.
GET - List/Get - Get the list of classes and the schedules you have created.
PATCH - Slots - Update the one of your classes with the class_id and Slot_id
PUT - Slots - Update the Schedule information for one of your classes with the class_id and Slot_id.
\n\nOnce you have completed this getting started guide we'd love to connect with you to discuss moving in to development, Webhook details and provide you with production credentials.
\n
We'd also love to hear any feedback on how you found this getting started guide.
There are 10 users that can be used to simulate activity in the testing environment.
\nThey are preset, dummy users with fake data.
\nThey in no way represent real users or Wellhub employees.
\nGympass ID (UUID) || Name of Test user
\n\n\nThe Gympass ID will always be a 13 digit integer
\n
1000000000001 (Mike Hightower)
\n1000000000002 (Thomas Patrick)
\n1000000000003 (Patty Cork)
\n1000000000004 (Kathleen Young)
\n1000000000005 (Susan Middaugh)
\n1000000000006 (Paul Charleston)
\n1000000000007 (Helen Powell)
\n1000000000008 (John Smith)
\n1000000000009 (Florence Hogan)
\n1000000000010 (Sharon Grace)
\nProduction Booking API URL : https://api.partners.gympass.com
\nAuthentication Token (bearer): Provided to you by the Wellhub Tech Sales team - see Authentication
\nExample of how to create a class on a given gym.
\nRequest
\n {\n \"classes\": [\n {\n \"name\": \"Test Class\",\n \"description\": \"Test class description\",\n \"notes\": \"Test class notes\",\n \"bookable\": true,\n \"visible\": true,\n \"is_virtual\": true,\n \"product_id\": 100003\n }\n ]\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n{\n \"classes\": [\n {\n \"id\": 8268,\n \"name\": \"Test Class\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"gyms/100001/classes/8268\"\n }\n ]\n }\n ]\n}\n\nExample of how to get a list of classes on a given gym.
\nHeaders
\nPath Variables
\nResponse
\n{\n \"classes\": [\n {\n \"id\": 1,\n \"name\": \"Cycle\",\n \"slug\": \"cycle\",\n \"description\": \"Our standard cycle classes\",\n \"notes\": \"Notes\",\n \"bookable\": true,\n \"visible\": true,\n \"product_id\": 1,\n \"gym_id\": 123,\n \"reference\": \"111\",\n \"created_at\": \"2019-07-03T17:44:22Z[UTC]\"\n },\n {\n \"id\": 2,\n \"name\": \"Super Cycle\",\n \"slug\": \"super-cycle\",\n \"description\": \"Our super advanced cycle class\",\n \"notes\": \"Notes\",\n \"bookable\": true,\n \"visible\": true,\n \"product_id\": 1,\n \"gym_id\": 123,\n \"reference\": \"111\",\n \"created_at\": \"2019-07-03T17:44:22Z[UTC]\",\n \"categories\": [\n {\n \"id\": 1,\n \"name\": \"Meditation\",\n \"locale\": \"de\"\n }\n ]\n }\n ]\n}\n\nExample of how to get a specific class resource.
\nHeaders
\nPath Variables
\nQuery String Parameters
\n*show-deleted=true Will show the results for both Class_ids that have been deleted and that are non-deleted. show-deleted=false will only show non-deleted Class_ids
Response
\n{\n \"id\": 1,\n \"name\": \"Judo\",\n \"slug\": \"judo-class-with-lasers\",\n \"description\": \"Description for judo classes.\",\n \"notes\": \"Some pretty notes here.\",\n \"bookable\": true,\n \"visible\": true,\n \"product_id\": 1,\n \"gym_id\": 1,\n \"reference\": \"111\",\n \"created_at\": \"2019-07-03T17:44:22Z[UTC]\",\n \"categories\": [\n {\n \"id\": 1,\n \"name\": \"Meditation\",\n \"locale\": \"de\"\n }\n ],\n}\n\nExample of how to update a class.
\nRequest
\n{\n \"name\": \"Super Cycle\",\n \"description\": \"Our standard cycle classes\",\n \"notes\": \"Notes of our standard cycle classes\",\n \"bookable\": true,\n \"visible\": true,\n \"reference\": \"111\",\n \"product_id\": 1,\n \"categories\": [\n 1,\n 2\n ]\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n204 - NO CONTENT\n\nA class represents one of the gym’s classes, like \"weightlifting\" or \"yoga\". To show the class on the Wellhub app and website, you need to create a slot that combines the class with a specific date and time it will occur. See slots session to see how to register a slot.
\n","_postman_id":"46c3a489-d50d-4b64-8bf9-afbc45adfdbb"},{"name":"Slots","item":[{"name":"Create slots","id":"346a4d03-12ce-4f14-81b5-bbd038bb3776","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"occur_date\": \"2022-09-29T22:00:50.000Z\",\n \"status\": 1,\n \"room\": \"Virtual test\",\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 5,\n \"product_id\": 100003,\n \"booking_window\": {\n \"opens_at\": \"2022-09-29T09:22:50.000Z\",\n \"closes_at\": \"2022-09-29T21:00:00.000Z\"\n },\n \"cancellable_until\": \"2022-09-29T18:05:00.000Z\",\n \"instructors\": [\n {\n \"name\": \"Virtual test\",\n \"substitute\": true\n }\n ],\n \"rate\": 4.0\n}","options":{"raw":{"language":"json"}}},"url":"https://apitesting.partners.gympass.com/booking/v1/gyms/gym_id/classes/class_id/slots","description":"Example of how to create a slot on a given class.
\nRequest
\n{\n \"occur_date\": \"2022-09-29T22:00:50.000Z\",\n \"status\": 1,\n \"room\": \"Virtual test\",\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 5,\n \"product_id\": 100003,\n \"booking_window\": {\n \"opens_at\": \"2022-09-29T09:22:50.000Z\",\n \"closes_at\": \"2022-09-29T21:00:00.000Z\"\n },\n \"cancellable_until\": \"2022-09-29T18:05:00.000Z\",\n \"instructors\": [\n {\n \"name\": \"Virtual test\",\n \"substitute\": true\n }\n ],\n \"rate\": 4.0\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n{\n \"metadata\": {\n \"total\": 1,\n \"errors\": 0\n },\n \"results\": [\n {\n \"id\": 9325,\n \"class_id\": 8268,\n \"occur_date\": \"2022-09-29T23:00:50Z\",\n \"status\": 1,\n \"room\": \"Virtual teste\",\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 5,\n \"product_id\": 100003,\n \"booking_window\": {\n \"opens_at\": \"2022-09-29T10:22:50Z\",\n \"closes_at\": \"2022-09-29T22:00:00Z\"\n },\n \"cancellable_until\": \"2022-09-29T16:02:00Z\",\n \"instructors\": [\n {\n \"name\": \"Virtual teste\",\n \"substitute\": true\n }\n ],\n \"virtual\": false\n }\n ]\n}\n\nExample of how to get a specific slot resource.
\nHeaders
\nPath Variables
\nResponse
\n{\n \"id\": 1,\n \"class_id\": 1,\n \"occur_date\": \"2019-07-09T10:00:00-03:00\",\n \"status\": 1,\n \"room\": \"Room 1\",\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 5,\n \"product_id\": 1,\n \"booking_window\": {\n \"opens_at\": \"2019-07-08T00:00:00-03:00\",\n \"closes_at\": \"2019-07-09T09:00:00-03:00\"\n },\n \"cancellable_until\": \"2019-07-09T09:08:00-03:00\",\n \"instructors\": [\n {\n \"name\": \"Axel\",\n \"substitute\": false\n },\n {\n \"name\": \"Blaze\",\n \"substitute\": true\n }\n ],\n \"rate\": 4.5,\n \"virtual\": true,\n \"virtual_class_url\": \"http://your_url.com\"\n}\n\nExample of how to get a list of slots of a given class in a given range of timezoned dates. If no form/to is informed, we will return all slots on that day.
\nParams
\nHeaders
\nPath Variables
\nResponse
\n{\n \"metadata\": {\n \"page\": 1,\n \"page_size\": 1000,\n \"total_elements\": 1,\n \"total\": 1,\n \"errors\": 0\n },\n \"results\": [\n {\n \"id\": 10849748,\n \"class_id\": 627457,\n \"occur_date\": \"2021-03-09T07:00:00Z[UTC]\",\n \"status\": 1,\n \"room\": \"Room 1\",\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 5,\n \"product_id\": 478142,\n \"booking_window\": {\n \"opens_at\": \"2021-03-09T06:30:00Z[UTC]\",\n \"closes_at\": \"2021-03-09T07:00:00Z[UTC]\"\n },\n \"cancellable_until\": \"2021-03-09T07:00:00Z[UTC]\",\n \"instructors\": [\n {\n \"name\": \"GYMPASS TEST\",\n \"substitute\": false\n }\n ],\n \"rating\": 4.5,\n \"virtual\": false\n }\n ]\n}\n\nExample of how to delete a slot forever. All bookings already done in this slot will be canceled automatically.
\nHeaders
\nPath Variables
\nResponse
\n204 - NO CONTENT\n\nExample of how to update partial info of the slot. For now, it is just possible to update total_booked and/or total_capacity. We recommend as good practice inform at least one of these fields. If you need to update other slot's information, please use PUT Update slot.
\nRequest
\n{\n \"total_capacity\": 15,\n \"total_booked\": 5,\n \"virtual_class_url\": \"http://your_url.com\"\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n204 - NO CONTENT\n\nExample of how to update all info of the slot.
\nRequest
\n{\n \"occur_date\": \"2019-07-09T10:00:00-03:00\",\n \"room\": \"Room 1\",\n \"status\": 1,\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 7,\n \"product_id\": 1,\n \"booking_window\": {\n \"opens_at\": \"2019-07-08T00:00:00-03:00\",\n \"closes_at\": \"2019-07-09T09:00:00-03:00\"\n },\n \"instructors\": [\n {\n \"name\": \"Axel\",\n \"substitute\": false\n },\n {\n \"name\": \"John\",\n \"substitute\": true\n }\n ],\n \"cancellable_until\": \"2019-07-09T09:00:00-03:00\",\n \"rate\": 4.5,\n \"virtual\": true,\n \"virtual_class_url\": \"http://your_url.com\"\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n{\n \"metadata\": {\n \"total\": 1,\n \"errors\": 0\n },\n \"results\": [\n {\n \"id\": 1,\n \"class_id\": 1,\n \"occur_date\": \"2019-07-09T10:00:00-03:00\",\n \"status\": 1,\n \"room\": \"Room 1\",\n \"length_in_minutes\": 60,\n \"total_capacity\": 15,\n \"total_booked\": 7,\n \"product_id\": 1,\n \"booking_window\": {\n \"opens_at\": \"2019-07-08T00:00:00-03:00\",\n \"closes_at\": \"2019-07-09T09:00:00-03:00\"\n },\n \"cancellable_until\": \"2019-07-09T09:08:00-03:00\",\n \"instructors\": [\n {\n \"name\": \"Axel\",\n \"substitute\": false\n },\n {\n \"name\": \"John\",\n \"substitute\": true\n }\n ],\n \"rate\": 4.5,\n \"virtual\": true\n }\n ]\n}\n\nA slot represents a class with specific date and time. For example, you can have a class called Yoga with a slot on Sunday at 9 AM and another slot on Monday at 8 AM.
\nA slot is always related to a class that was previously registered. See class session to find out how to register a class.
\n","_postman_id":"7099574b-85fd-4269-8625-f6b642e16073"},{"name":"Bookings","item":[{"name":"Validate Booking","id":"116ab0c2-ef09-4d74-bf93-8d5fc5ea1d63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"REJECTED\",\n \"reason\": \"Class is full\",\n \"reason_category\": \"CLASS_IS_FULL\",\n \"virtual_class_url\": \"http://your_url.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apitesting.partners.gympass.com/booking/v2/gyms/:gym_id/bookings/:booking_number","description":"Example of how to update the status of a given booking.
\nWhen calling the PATCH update you must pass through either a 2 (Reserved Booking), a 3 (Rejected Booking) or 5 (Cancelled by the Gym).
\nRequest
\n {\n \"status\": \"REJECTED\",\n \"reason\": \"Class is full\",\n \"reason_category\": \"CLASS_IS_FULL\",\n \"virtual_class_url\": \"http://your_url.com\"\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n204 - 0K - NO CONTENT\n\nIMPORTANT: Booking requests need to be confirmed under 15 minutes, otherwise they will be automatically rejected.
\n","_postman_id":"89759fbb-1008-430d-b44f-39af53e6b8fd"}],"id":"49cb417c-0ddb-4d3a-99cb-286545755d96","description":"Endpoints to perform booking operations in order to test the integration, such as class creation and slot creation (needed to test the booking flow).
\n","_postman_id":"49cb417c-0ddb-4d3a-99cb-286545755d96"},{"name":"Partner Products","item":[{"name":"List gym products","id":"140ec58d-bec8-413a-afee-10394df14d64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://apitesting.partners.gympass.com/setup/v1/gyms/gym_id/products","description":"Example of how to list all products of a particular gym.
\nHeaders
\nPath Variables
\nResponse
\n{\n \"gym_id\": 100001,\n \"products\": [\n {\n \"product_id\": 100003,\n \"name\": \"Virtual Class\",\n \"updated_at\": \"2022-09-29T14:11:02Z\"\n },\n {\n \"product_id\": 100002,\n \"name\": \"Outdoor Training\",\n \"updated_at\": \"2022-09-29T14:11:02Z\"\n }\n ]\n}\n\nA Product determines what Gyms a user can access on a Wellhub plan. In addition, the product also represents an activity that the user can perform, so its data commonly required to provide on some requests, such as for creating a class.
\nFor this purpose, we provide an API that allows you to retrieve all Products that are associated with a Gym, so you can use the correct Product IDs on your integration setup.
\n","_postman_id":"08e42375-9c99-44a1-a69e-ff251de44743"},{"name":"Webhook Events","item":[{"name":"Check-in Event","id":"348c32e8-2be4-4e63-ac4d-dfe6cb64c926","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Gympass-Signature","value":"","type":"text"}],"body":{"mode":"raw","raw":" {\n \"event_type\": \"checkin\",\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"0123456789012\",\n \"first_name\": \"Firstname\",\n \"last_name\": \"Lastname\",\n \"email\": \"user@email.com\",\n \"phone_number\": \"447889123456\"\n },\n \"location\": {\n \"lat\": 51.4937541,\n \"lon\": 0.0633661\n },\n \"gym\": {\n \"id\": 123456,\n \"title\":\" Name of the Gym\",\n \"product\": {\n \"id\": 1\n \"description\":\"Description of product\"\n }\n },\n \"timestamp\": 1666629613\n }\n }"},"url":"https://your-webhook-url-here.com","urlObject":{"protocol":"https","host":["your-webhook-url-here","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"348c32e8-2be4-4e63-ac4d-dfe6cb64c926"},{"name":"Booking Request Event","event":[{"listen":"prerequest","script":{"id":"c0caaf60-1306-4411-b4a9-2f8d73c20723","exec":["const hash = CryptoJS.HmacSHA1(request.data, 'office_eagle_consider').toString(CryptoJS.digest).toUpperCase();","console.log(hash);","pm.globals.set(\"hash\", hash);"],"type":"text/javascript"}}],"id":"05edd434-c90e-44df-a61d-5ba4135f099d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-gympass-signature","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"booking-requested\",\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"123456789012\",\n \"name\": \"Firstname Lastname\",\n \"email\": \"user@email.com\"\n },\n \"slot\": {\n \"id\": 01234567,\n \"gym_id\": 012345,\n \"class_id\": 654321,\n \"booking_number\": \"BK_A1B2C3\"\n },\n \"timestamp\": 1560983373378,\n \"event_id\": \"7e8cbb0f-9681-4d3e-8c36-2b3dd6ecbadb\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url-here.com","urlObject":{"protocol":"https","host":["your-webhook-url-here","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"05edd434-c90e-44df-a61d-5ba4135f099d"},{"name":"Booking Cancellation Event Copy","event":[{"listen":"prerequest","script":{"id":"c0caaf60-1306-4411-b4a9-2f8d73c20723","exec":["const hash = CryptoJS.HmacSHA1(request.data, 'office_eagle_consider').toString(CryptoJS.digest).toUpperCase();","console.log(hash);","pm.globals.set(\"hash\", hash);"],"type":"text/javascript"}}],"id":"29af6dcf-e919-43d4-aa20-3455104007dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-gympass-signature","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"booking-canceled\",\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"123456789012\"\n },\n \"slot\": {\n \"id\": 01234567,\n \"gym_id\": 012345,\n \"class_id\": 654321,\n \"booking_number\": \"BK_A1B2C3\"\n },\n \"timestamp\": 1560983373378,\n \"event_id\": \"7e8cab0f-9981-4d3e-8c36-2b3dd6ecbadb\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url-here.com","urlObject":{"protocol":"https","host":["your-webhook-url-here","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"29af6dcf-e919-43d4-aa20-3455104007dd"},{"name":"Booking Late Cancellation Event","id":"212557dc-9458-4206-900f-bff6e43095b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event_type\": \"booking-late-canceled\",\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"123456789012\"\n },\n \"slot\": {\n \"id\": 01234567,\n \"gym_id\": 012345,\n \"class_id\": 654321,\n \"booking_number\": \"BK_A1B2C3\"\n },\n \"timestamp\": 1560983373378,\n \"event_id\": \"7e8cab0f-9981-4d3e-8c36-2b3dd6ecbadb\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url-here.com","urlObject":{"protocol":"https","host":["your-webhook-url-here","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"212557dc-9458-4206-900f-bff6e43095b3"}],"id":"957ac84f-7ffd-453f-858a-a8a052c26cad","description":"The Gympass webhooks will notify you when specific events are triggered. This notification is an HTTP POST request to your registered URL.
\nThis document describes both the events that are triggered along with the data they send and the API resources available for the webhooks.
\n","_postman_id":"957ac84f-7ffd-453f-858a-a8a052c26cad"},{"name":"Webhook Simulations","item":[{"name":"Create Booking","id":"aecc2e3b-25e3-47ef-8b08-22571ddd9f19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Example of how to simulate a booking for a specific gym.
\nRequest
\n{\n \"gympass_user_id\": \"1000000000002\",\n \"slot_id\": 9325,\n \"class_id\": 8268\n}\n\nRequest Params
\nHeaders
\nPath Variables
\nResponse
\n{\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"1000000000002\",\n \"name\": \"Thomas Patrick\",\n \"email\": \"thomas@mail.com\",\n \"phone_number\": \"+19415693005\"\n },\n \"slot\": {\n \"id\": 9325,\n \"gym_id\": 100001,\n \"class_id\": 8268,\n \"booking_number\": \"BK_HEQYZMK\"\n },\n \"timestamp\": 1664461204015,\n \"event_id\": \"45b4b8a4-f2f3-4b33-adf0-504c33f27642\"\n },\n \"event_type\": \"booking-requested\"\n}\n\nExample of how to simulate a booking cancellation/late cancel.
\nHeaders
\nPath Variables
\nCancel Response
\n{\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"1000000000003\",\n \"name\": \"Patty Cork\",\n \"email\": \"patty@mail.com\",\n \"phone_number\": \"+19403811663\"\n },\n \"slot\": {\n \"id\": 9324,\n \"gym_id\": 100001,\n \"class_id\": 8268,\n \"booking_number\": \"BK_VLZNUIJ\"\n },\n \"timestamp\": 1664462883131,\n \"event_id\": \"a42d8911-4447-4df8-8a79-095657c0af26\"\n },\n \"event_type\": \"booking-canceled\"\n}\n\nLate Cancel Response
\n{\n \"event_data\": {\n \"user\": {\n \"unique_token\": \"1000000000003\",\n \"name\": \"Patty Cork\",\n \"email\": \"patty@mail.com\",\n \"phone_number\": \"+19403811663\"\n },\n \"slot\": {\n \"id\": 9324,\n \"gym_id\": 100001,\n \"class_id\": 8268,\n \"booking_number\": \"BK_VLZNUIJ\"\n },\n \"timestamp\": 1664462883131,\n \"event_id\": \"a42d8911-4447-4df8-8a79-095657c0af26\"\n },\n \"event_type\": \"booking-late-canceled\"\n}\n\nEndpoints to perform integration simulations.
\n","_postman_id":"4b5141c4-25e6-467d-9660-ed030791f79a"},{"name":"Access Control API","item":[{"name":"Validate Checkin","id":"b205ee9c-7833-4832-adb5-5a431a0adaa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-Gym-Id","value":"gym_id","type":"text"}],"body":{"mode":"raw","raw":"{\"gympass_id\":\"1000000000001\"}","options":{"raw":{"language":"json"}}},"url":"https://apitesting.partners.gympass.com/access/v1/validate","description":"Example of how to validate the entry of users at a gym and consequently generate transactions to pay them later.
\nRequest
\n{\"gympass_id\":\"1000000000001\"}\n\nRequest Params
\nHeaders
\nResponse
\n{\n \"metadata\": {\n \"total\": 1,\n \"errors\": 0\n },\n \"results\": {\n \"user\": {\n \"gympass_id\": \"1000000000001\"\n },\n \"gym\": {\n \"id\": 1,\n \"product\": {\n \"id\": 2,\n \"description\": \"Produto Teste 2\"\n }\n },\n \"validated_at\": \"2022-09-20T14:24:10Z\"\n }\n}\n\nEndpoints to perform util operations in order to test the integration, such as class creation and slot creation (needed to test the booking flow).
\n","_postman_id":"bc788dda-3551-408c-8289-6a0c0504fae0"}],"event":[{"listen":"prerequest","script":{"id":"a3c9ff2b-06ec-4186-827e-552e99c106a7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dca1954c-e22a-47d9-9cac-1540def3cf6b","type":"text/javascript","exec":[""]}}],"variable":[{"key":"partners-testing-helper-api","value":"https://apitesting.partners.gympass.com/helper/v1","type":"string"},{"key":"partners-testing-helper-booking-api","value":"https://apitesting.partners.gympass.com/booking/v1","type":"string"},{"key":"partners-testing-helper-gym-access-api","value":"https://apitesting.partners.gympass.com/access/v1","type":"string"},{"key":"partners-testing-helper-setup-api","value":"https://apitesting.partners.gympass.com/setup/v1","type":"string"},{"key":"api_key","value":""}]}