Overview
The Nexxchange API connects your company with the Nexxchange GolfSuite, the all-in-one cloud based golf club management software solution from Nexxchange. It allows your company to perform teetime bookings at a quickly growing list of golf clubs by electronically sending API calls to the Nexxchange Agent API endpoints.
The Nexxchange Agent API currently offers the following endpoints:
List golf clubs (issuers)
List tee times for a particular golf club
Get a quote for a tee time
Book a tee time
Cancel a tee time
Review order status
Agent API Access
A Nexxchange Agent API account is required to start submitting API requests. The signup process for such an account is started by filling out the signup online form (Test/Live).
Once Nexxchange staff has verified your account, you will receive a notification with your account activation link. Click on the account activation link to start using your Nexxchange Agent API account.
Once you are logged in, you can generate your API key. Go to the the API access administration page (live/test) to generate an API key. Note that you first have to agree to the Nexxchange Agent API terms and conditions.
Once you have agreed to the terms and conditions you will be able generate an API key.
and review it on the same page.
Now that you have generated your API key you can start submitting API requests to the Nexxchange API entry point (test/live).
Essential URLs Overview
Find below two tables, one for the test system and one for the live system, showing an overview of the most essential API Agent URLs.
Test System
Nexxchange API Agent Signup | |
Nexxchange Agent API Tems and Conditions | |
API Access Configuration | |
Business Partner Administration | |
API Entry Point | |
Open API Documentation Page | https://apitest.nexxchange.com/docs/index.html?url=/docs/docs.yaml#/ |
Live System
Nexxchange API Agent Signup | |
Nexxchange Agent API Tems and Conditions | |
API Access Administration | |
Business Partner Administration | |
API Entry Point | |
Open API Documentation Page | https://agentapi.nexxchange.dev/docs/index.html?url=/docs/docs.yaml#/ |
Negotiating an Agent Agreement
Before API requests can be routed to a particular golf club, it is necessary to set up an agent agreement.
Go to the Business Partner Administration (Test/Live) page to list all available golf clubs.
Click the "Contact Golf Club" button to select the golf club of your choice.
Next click the “Send Message” button to send a collaboration request (including the optional message) to the selected golf club.
The Nexxchange GolfSuite operator will receive a notification and will start to configure the various parameters of your agent agreement (discounts, invoicing, etc.) and upload it to the Nexxchange Market Place (Test/Live) for your approval.
Once you have approved the agent agreement conditions using the dashboard of the corresponding golf club (accessible via the Business Partner Administration Test/Live) page you can start sending API requests to the selected golf club.
API Integration
The easiest way to integrate the Nexxchange Agent API is to take advantage of the Open API documentation page available on our test system. Apply for a API agent account on our test system to start submitting API requests.
To get going you first need to click the "Authorize" button on this page and enter your API key (see details given above). Once the API key is entered you can start sending test requests to the Nexxchange backend directly from the Open API documentation page.
The first submitted request is usually intended to query all available golf clubs (issuers) and its courses using the /issuers
endpoint. Note that you will only receive information on golf clubs with whom you have an active agent agreement (see above on how to setup the agent agreement).
Using the issuer ID of one of the returned golf clubs, you can go ahead and query all available tee times using the teetimes
API call.
Once you have found a suitable tee time, you can use the book
API call to reserve and purchase a tee time. A quote
API call is also available to preview a booking, i.e. get prices without actually booking the selected tee time.
The getOrderByReference
API call can be used for order recovery in case a booking transaction was interrupted.
Finally use the cancel
API call to cancel a booking.