Skip to main content

​
Prerequisites

1

API Key

You’ll need a valid API key. If you don’t have one, contact hello@arqqin.com to obtain your key.
2

HTTP Client

Use any HTTP client like cURL, Postman, or your preferred programming language’s HTTP library.
3

Base URL

Use the staging environment for testing: https://apistg.arqq.in/api/

​
Quick Downloads

Postman Collection

Import our complete API collection into Postman for easy testing

OpenAPI Specification

Download the complete OpenAPI 3.0 specification

​
Step 1: Test Your Connection

Start by testing your API key with the health check endpoint: 
curl -X GET "https://apistg.arqq.in/api/health" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
You should receive a response like:
{
  "status": "healthy",
  "timestamp": "2024-01-20T16:30:00Z",
  "service": "arqqin-parking-management",
  "version": "1.0.0"
}

​
Step 2: List Your Companies

First, discover the companies you have access to: 
curl -X GET "https://apistg.arqq.in/api/companies" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Step 3: List Available Locations

Discover the locations you have access to: 
curl -X GET "https://apistg.arqq.in/api/locations" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Step 4: Add a Vehicle to Whitelist

Now let’s add a vehicle to the whitelist. Replace location_123 with your actual location ID: 
curl -X POST "https://apistg.arqq.in/api/locations/location_123/whitelist" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "referenceId": "RESIDENT_001",
    "plateType": "DXB",
    "plateCode": "White",
    "plateNumber": "12345",
    "vehicleType": "Sedan",
    "note": "Primary vehicle for apartment 4B"
  }'

​
Step 5: List Whitelist Vehicles

Verify your vehicle was added by listing all whitelist vehicles: 
curl -X GET "https://apistg.arqq.in/api/locations/location_123/whitelist" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Step 6: Get Location Status

Check the current parking status of your location: 
curl -X GET "https://apistg.arqq.in/api/locations/location_123/status" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Next Steps

Complete API Reference

Explore all available endpoints and their parameters.

Whitelist Management Guide

Learn advanced whitelist management techniques.

Error Handling

Understand error responses and best practices.

Integration Examples

See real-world integration examples and SDKs.

​
Common Issues

This usually means:
  • Missing or invalid API key
  • API key not properly formatted in header
  • API key doesn’t have access to the requested resource
Double-check your API key and ensure it’s included in the X-API-Key header.
This typically indicates:
  • Invalid location ID
  • Endpoint URL is incorrect
  • Resource doesn’t exist
Verify your location ID and endpoint URLs match the API reference.
This means:
  • Required fields are missing
  • Invalid data format (e.g., non-numeric plate numbers)
  • Invalid plate type or code format
Check the validation rules in the API reference and ensure your data matches the expected format.