Sync permit registrations from Offstreet into your AIMS parking system
Offstreet integrates with AIMS Parking Management Software to push active permit data directly into your enforcement system. This guide outlines how to get the integration set up and validated.
Integration Overview
Offstreet pushes licence plate registration data to your AIMS system using AIMS’ API. Zone Codes are used to map Offstreet locations to corresponding zones in AIMS. Once configured, Offstreet automatically sends active registrations in real time.
This is a push-based integration: Offstreet initiates the data transfer to AIMS using your credentials and endpoint.
What You’ll Need
Requirement | Description | Who Provides It |
---|---|---|
AIMS API Key | Used to authenticate Offstreet’s API requests | You (from your AIMS admin) |
AIMS API URL | The endpoint where Offstreet sends permit data | You (or your IT team) |
Whitelisted IPs | Offstreet will provide IP addresses that must be allowed by your firewall | Offstreet |
Zone Codes / Zone Names | Used to map Offstreet locations to AIMS zones | Offstreet |
Step-by-Step Setup
1. Send API Credentials and URL
Ask your AIMS administrator or IT team for:
- The AIMS API URL
- Your API Key
- Confirmation that Offstreet’s IP addresses are whitelisted
Then send all three to your Offstreet account manager.
2. Offstreet Sets Up the Integration
Once credentials are received, Offstreet will:
- Set up the secure API connection
- Assign Zone Codes (also called Zone Names) to each Offstreet location
- Enable the integration for your company and locations within Offstreet
No action is needed on your end during this step.
3. Enter Zone Codes in AIMS
Offstreet will send you a list of Zone Codes that correspond to your Offstreet locations.
You (or your AIMS admin) must enter these Zone Codes into your AIMS system.
Note: Zone Codes must match exactly in AIMS and Offstreet (case-sensitive, no extra characters).
4. Test and Confirm
Once Zone Codes are entered:
- Offstreet will create a test registration (e.g., plate:
TEST123
) - You or your AIMS contact will confirm the plate appears correctly in your AIMS dashboard
Once confirmed, the integration is live.
Troubleshooting Tips
Issue | What to Check |
---|---|
Test registration not appearing | Confirm the Zone Code is entered correctly in AIMS (exact match required) |
API not responding | Make sure IPs are whitelisted and the URL ends in .svc/json |
Invalid API Key errors | Ask your AIMS admin to regenerate the key and resend |
Need Help?
- AIMS Support: Contact your AIMS administrator or IT team
- Offstreet Support: Reach out to your Offstreet Account Manager or Contact Support
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article