Skip to content
Last updated

🔌 OpenAPI Integration Guide

This guide will help you integrate our OpenAPI-based API and generate a client SDK in the technology of your choice.

📄 1. Get the OpenAPI Specification

Download or access the OpenAPI 3.0.3 spec for the Bookings VenueAPI:

You can use this spec with a variety of tools to generate clients or documentation.

⚙️ 2. Generate Client SDKs

Use the OpenAPI Generator or Swagger Codegen to generate client libraries in your preferred language:

🔧 OpenAPI Generator (Recommended)

Install it via npm:

npm install @openapitools/openapi-generator-cli -g

Generate a client (example in TypeScript):

openapi-generator-cli generate \
  -i https://api.bookabletech.com/openapi.json \
  -g typescript-fetch \
  -o ./venue-api-client

Supported languages include:

👉 OpenAPI Generator Documentation

🧪 Swagger Codegen (Alternative)

If you prefer Swagger Codegen:

brew install swagger-codegen
Generate a client (example in Java):
swagger-codegen generate \
  -i https://api.bookabletech.com/openapi.json \
  -l java \
  -o ./venue-api-client-java

👉 Swagger Codegen GitHub

🔐 3. Authentication Setup

Our API uses OAuth2 Client Credentials. You can obtain an access token by calling the Auth0 endpoint:

curl -X POST https://bookabletech.uk.auth0.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "audience": "api.bookabletech.com"
  }'

Use the returned access token in the Authorization header of your API calls:

Authorization: Bearer YOUR_ACCESS_TOKEN

📘 Additional Resources

OpenAPI Specification

Postman Import Guide

Auth0 Client Credentials Grant

 
Next page