GateGuard Connect

Integration Guide

21Endpoints
6Sections

API Overview

Build GateGuard Connect integrations faster

This is a Postman Collection to develop, test and maintain APIs for GateGuard-Connect integration.

Authentication first Start with SDK Login to generate the bearer token used by protected endpoints.
Operational resources Manage cameras, devices, vehicle owners, vehicles, combined owner-vehicle records, and event data.
Postman ready Download the collection and environment, import both into Postman, then set your host and token values.
Download Collection Download Environment

Integrations / Login

1 endpoint
POST

SDK Login

https://{{host}}/api/v1/integration/login

Body

{
  "client_id": "",
  "client_secret": ""
}

cURL

curl --request 'POST' \
  --url 'https://{{host}}/api/v1/integration/login' \
  --data '{
    "client_id": "",
    "client_secret":""
  }'

Integrations / Cameras/Devices

1 endpoint
GET

List Cameras/Devices

http://{{host}}/api/v1/integration/devices

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/devices' \
  --header 'Authorization: {{Bearer}}'

Integrations / Vehicle-Owners

6 endpoints
GET

List Vehicle-Owner-Types

https://{{host}}/api/v1/integration/owner-type

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'GET' \
  --url 'https://{{host}}/api/v1/integration/owner-type' \
  --header 'Authorization: {{Bearer}}'
POST

Create Owner

https://{{host}}/api/v1/integration/vehicleowner

Headers

Key Value
Authorization {{Bearer}}

Body

{
  "name": "SDK User",
  "phone_number": "9999999999",
  "owner_type": 4,
  "flat_number": "A-102",
  "is_custom_flat_number": false,
  "device": [],
  "validity_start_date": "2024-08-06",
  "validity_end_date": "2024-08-31"
}

cURL

curl --request 'POST' \
  --url 'https://{{host}}/api/v1/integration/vehicleowner' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
    "name": "SDK User",
    "phone_number": "9999999999",
    "owner_type": 4,
    "flat_number": "A-102",
    "is_custom_flat_number": false,
    "device": [],
    "validity_start_date": "2024-08-06",
    "validity_end_date": "2024-08-31"
}'
GET

List Owners

http://{{host}}/api/v1/integration/vehicleowner

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/vehicleowner'
GET

List Owner Details by ID

http://{{host}}/api/v1/integration/vehicleowner/10240

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/vehicleowner/10240' \
  --header 'Authorization: {{Bearer}}'
PATCH

Update Owner Details by ID

https://{{host}}/api/v1/integration/vehicleowner/10240

Headers

Key Value
Authorization {{Bearer}}

Body

{
  "name": "SDK changes",
  "phone_number": "8888888888",
  "owner_type": 1,
  "flat_number": "A-102",
  "is_custom_flat_number": false,
  "device": [],
  "validity_start_date": "2024-08-06",
  "validity_end_date": "2024-08-31"
}

cURL

curl --request 'PATCH' \
  --url 'https://{{host}}/api/v1/integration/vehicleowner/10240' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
    "name": "SDK changes",
    "phone_number": "8888888888",
    "owner_type": 1,
    "flat_number": "A-102",
    "is_custom_flat_number": false,
    "device": [],
    "validity_start_date": "2024-08-06",
    "validity_end_date": "2024-08-31"
}'
DELETE

Delete Owner by ID

https://{{host}}/api/v1/integration/vehicleowner/10240

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'DELETE' \
  --url 'https://{{host}}/api/v1/integration/vehicleowner/10240' \
  --header 'Authorization: {{Bearer}}'

Integrations / Vehicles

5 endpoints
GET

List Vehicle Types

https://{{host}}/api/v1/integration/vehicle-types

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'GET' \
  --url 'https://{{host}}/api/v1/integration/vehicle-types' \
  --header 'Authorization: {{Bearer}}'
POST

Create Vehicle

https://{{host}}/api/v1/integration/vehicle

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Body

{
  "number_plate": "MH15X3633",
  "vehicle_type": 1,
  "auth_type": "whitelist",     // "blacklist" also availalbe
  "comment": null,
  "owner": 33380
}

cURL

curl --request 'POST' \
  --url 'https://{{host}}/api/v1/integration/vehicle' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
  "number_plate": "MH15X3633",
  "vehicle_type": 1,
  "auth_type": "whitelist",     // "blacklist" also availalbe
  "comment": null,
  "owner": 33380
}'
GET

List Vehicles

https://{{host}}/api/v1/integration/vehicle

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Query Parameters

Key Value Enabled
number_plate MH18Z9527 No
vehicle_type 1 No
owner 1024 No
auth_type whitelist No

cURL

curl --request 'GET' \
  --url 'https://{{host}}/api/v1/integration/vehicle' \
  --header 'Authorization: {{Bearer}}'
PATCH

Update Vehicle by ID

https://{{host}}/api/v1/integration/vehicle/10517

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Body

{
    "owner": 10452,
    "number_plate": "MH12TY3826",
    "vehicle_type": 1,
    "auth_type": "whitelist", // "blacklist" also availalbe
    "comment": "smmsdvmmodm"
}

cURL

curl --request 'PATCH' \
  --url 'https://{{host}}/api/v1/integration/vehicle/10517' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
    "owner": 10452,
    "number_plate": "MH12TY3826",
    "vehicle_type": 1,
    "auth_type": "whitelist", // "blacklist" also availalbe
    "comment": "smmsdvmmodm"
}'
DELETE

Delete Vehicle by ID

https://{{host}}/api/v1/integration/vehicle/59964

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Body

cURL

curl --request 'DELETE' \
  --url 'https://{{host}}/api/v1/integration/vehicle/59964' \
  --header 'Authorization: {{Bearer}}'

Integrations / Vehicles & Vehicle-Owners Combine

4 endpoints
GET

List Owners and their vehicles

https://{{host}}/api/v1/integration/vehicle-owner-vehicles

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Query Parameters

Key Value Enabled
page 14 No
search Abdul No
number_plate MH16X3634 No
vehicle_type 1 No
auth_type whitelist No
owner 35190 No

cURL

curl --request 'GET' \
  --url 'https://{{host}}/api/v1/integration/vehicle-owner-vehicles' \
  --header 'Authorization: {{Bearer}}'
POST

Create Owner with their Vehicles

https://{{host}}/api/v1/integration/vehicle-owner-vehicles

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Body

{
  "name": "Testing",
  "owner_type": 1,
  "vehicles": [
    {
      "number_plate": "MH12SJ8695",
      "vehicle_type": 0,
      "auth_type": "whitelist"
    }
  ],
  "flat_number": "A-101",
  "is_custom_flat_number": true,
  "device": []
}

cURL

curl --request 'POST' \
  --url 'https://{{host}}/api/v1/integration/vehicle-owner-vehicles' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
    "name": "Testing",
    "owner_type": 1,
    "vehicles": [
        {
            "number_plate": "MH12SJ8695",
            "vehicle_type": 0,
            "auth_type": "whitelist"
        }
    ],
    "flat_number": "A-101",
    "is_custom_flat_number": true,
    "device": []
}'
POST

Bulk Create/Update Vehicle Owner Vehicle

https://{{host}}/api/v1/integration/bulk/vehicle-owner-vehicle

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Body

{
  "is_custom_flat_number": true,
  "data": [
    {
      "name": "Testing-1",
      "phone_number": "6000000000",
      "owner_type": 1,
      "vehicle": [
        {
          "number_plate": "MH19Z9525",
          "vehicle_type": 0,
          "auth_type": "whitelist"
        },
        {
          "number_plate": "MH18Z9526",
          "vehicle_type": 0,
          "auth_type": "whitelist"
        }
      ],
      "flat_number": "A-101",
      "is_custom_flat_number": true,
      "device": [],
      "validity_start_date": "",
      "validity_end_date": ""
    }
  ]
}

cURL

curl --request 'POST' \
  --url 'https://{{host}}/api/v1/integration/bulk/vehicle-owner-vehicle' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
  "is_custom_flat_number": true,
  "data": [
    {
      "name": "Testing-1",
      "phone_number": "6000000000",
      "owner_type": 1,
      "vehicle": [
        {
          "number_plate": "MH19Z9525",
          "vehicle_type": 0,
          "auth_type": "whitelist"
        },
        {
          "number_plate": "MH18Z9526",
          "vehicle_type": 0,
          "auth_type": "whitelist"
        }
      ],
      "flat_number": "A-101",
      "is_custom_flat_number": true,
      "device": [],
      "validity_start_date": "",
      "validity_end_date": ""
    }
  ]
}'
PATCH

Update Owner and their Vehicle Details by ID

http://{{host}}/api/v1/integration/vehicle-owner-vehicles/35027

Auth: noauth

Headers

Key Value
Authorization {{Bearer}}

Body

{
  "name": "Adesh Kothari",
  "phone_number": "9939292929",
  "owner_type": 3,
  "society": 5,
  "vehicles": [
    {
      "id": 59854,
      "number_plate": "MH04LG6717",
      "vehicle_type": 0,
      "auth_type": "whitelist"
    },
    {
      "number_plate": "MH21BR6640",
      "vehicle_type": 0,
      "auth_type": "whitelist"
    }
  ],
  "flat_number": "B-402",
  "is_custom_flat_number": false,
  "device": [
    5,
    11,
    13,
    16,
    72
  ],
  "validity_start_date": "2024-01-01",
  "validity_end_date": "2025-01-01"
}

cURL

curl --request 'PATCH' \
  --url 'http://{{host}}/api/v1/integration/vehicle-owner-vehicles/35027' \
  --header 'Authorization: {{Bearer}}' \
  --data '{
  "name": "Adesh Kothari",
  "phone_number": "9939292929",
  "owner_type": 3,
  "society": 5,
  "vehicles": [
    {
      "id": 59854,
      "number_plate": "MH04LG6717",
      "vehicle_type": 0,
      "auth_type": "whitelist"
    },
    {
      "number_plate": "MH21BR6640",
      "vehicle_type": 0,
      "auth_type": "whitelist"
    }
  ],
  "flat_number": "B-402",
  "is_custom_flat_number": false,
  "device": [
    5,
    11,
    13,
    16,
    72
  ],
  "validity_start_date": "2024-01-01",
  "validity_end_date": "2025-01-01"
}'

Integrations / Events/Data

4 endpoints
GET

List All Events/logs/data

http://{{host}}/api/v1/integration/events

Headers

Key Value
Authorization {{Bearer}}

Query Parameters

Key Value Enabled
number_plate MH12VW9414 No
vehicle_type 0 No
owner 8370 No
camera CAM1 No
is_unauthorized true No
device 39 No
timestamp__gt 2024-01-01 00:00:00 No
timestamp__gte 2024-01-01 00:00:00 No
timestamp__lt 2024-01-01 00:00:00 No
timestamp__lte 2024-01-01 00:00:00 No

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/events' \
  --header 'Authorization: {{Bearer}}'
GET

List Event/log/data by ID

http://{{host}}/api/v1/integration/events/12345

Headers

Key Value
Authorization {{Bearer}}

Query Parameters

Key Value Enabled
number_plate MH12SJ8695 No
vehicle_type 0 No
owner 8370 No
camera CAM1 No
is_unauthorized true No
device 39 No
timestamp__gt 2024-01-01 00:00:00 No
timestamp__gte 2024-01-01 00:00:00 No
timestamp__lt 2024-01-01 00:00:00 No
timestamp__lte 2024-01-01 00:00:00 No

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/events/12345' \
  --header 'Authorization: {{Bearer}}'
GET

List Visitor Events/logs/data

http://{{host}}/api/v1/integration/visitor

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/visitor' \
  --header 'Authorization: {{Bearer}}'
GET

List Visitor Event/logs/data by ID

http://{{host}}/api/v1/integration/visitor/58

Headers

Key Value
Authorization {{Bearer}}

cURL

curl --request 'GET' \
  --url 'http://{{host}}/api/v1/integration/visitor/58' \
  --header 'Authorization: {{Bearer}}'