Offstreet OpenAPI Integration Guide

Created by Jenna Rodgers, Modified on Tue, Aug 12 at 3:06 PM by Jenna Rodgers

Offstreet OpenAPI

Programmatically issue permits, validate plates, and access Offstreet data

The Offstreet OpenAPI allows your system to connect with Offstreet in real time to issue permits, validate licence plates, and access location or event data. The API is REST-based, well-documented, and easy to work with.

View the full documentation here: Offstreet OpenAPI on SwaggerHub

Overview

With Offstreet’s OpenAPI, you can:

Programmatically create and manage parking permits
Validate licence plates during enforcement
Retrieve Offstreet locations and event data
Seamlessly integrate Offstreet with other systems (e.g., CRMs, kiosks, gate access tools)

What You’ll Need

Requirement	Description	Who Provides It
API Key (Bearer Token)	Used to authenticate your API requests	Offstreet
API Base URL	Separate endpoints for sandbox and production environments	Offstreet
Developer or Integrator	Someone on your team to implement the API	You

Step-by-Step Setup

1. Request API Access

Reach out to your Offstreet account manager or support@joinoffstreet.com to request:

Your API Key (Bearer token)
The Base URL for your environment (sandbox or production)

2. Review Available Endpoints

Key endpoints include:

Endpoint	Description
`POST /permits`	Create a new permit
`GET /locations`	Fetch a list of Offstreet locations
`GET /enforcement/validate`	Check if a licence plate has a valid permit
`GET /events`	Retrieve event data related to permit activity

Each endpoint includes full Swagger documentation with required fields, sample payloads, and response examples.

3. Authenticate API Requests

All requests must include your Bearer token in the header.

4. Test and Integrate

You can test the API directly in SwaggerHub using the "Try it out" feature.

Once your integration is ready, you can:

Create permits from a CRM, kiosk, gate, or other source
Validate licence plates in real-time enforcement workflows
Sync Offstreet data to other systems

Need Help?

Reach out to your Offstreet Account Manager or Contact Support if you:

Need help setting up your credentials or environment
Have questions about how to use a specific endpoint
Encounter issues during testing or implementation