Saltar al contenido principal

Parking API

The Parking API provides endpoints for managing parking locations and their associated plans.

Get Parkings List

Retrieves a list of all parking locations.

Endpoint

GET /api/v3/business/parkings/list

Headers

HeaderValueRequired
AuthorizationBearer {token}Yes

Response

[
{
"id": 0,
"name": "string",
"address": "string",
"lat": "string",
"lon": "string",
"city": "string",
"status": "string"
}
]
FieldTypeDescription
idintegerThe ID of the parking location
namestringThe name of the parking location
addressstringThe address of the parking location
latstringThe latitude coordinate
lonstringThe longitude coordinate
citystringThe city where the parking is located
statusstringThe current status of the parking location

Example

curl -X GET \
'https://api.parkup.cl/api/v3/business/parkings/list' \
-H 'Authorization: Bearer \{your_access_token\}'

Get Parking Detail

Retrieves detailed information about a specific parking location.

Endpoint

GET /api/v3/business/parkings/detail

Query Parameters

ParameterTypeRequiredDescription
idintegerYesThe ID of the parking location

Response

{
"id": 0,
"name": "string",
"address": "string",
"lat": "string",
"lon": "string",
"city": "string",
"status": "string",
"image": "string",
"minutePrice": 0,
"minutePenaltyPrice": 0,
"description": {
"access": {
"driving": "string",
"walking": "string"
},
"observation": {
"text": "string",
"type": "string"
},
"description": "string"
},
"subscriptions": []
}
FieldTypeDescription
idintegerThe ID of the parking location
namestringThe name of the parking location
addressstringThe address of the parking location
latstringThe latitude coordinate
lonstringThe longitude coordinate
citystringThe city where the parking is located
statusstringThe current status of the parking location
imagestringThe image URL of the parking location
minutePriceintegerThe price per minute for parking
minutePenaltyPriceintegerThe penalty price per minute
descriptionobjectAdditional description details
subscriptionsarrayList of subscriptions associated with the parking

Example

curl -X GET \
'https://api.parkup.cl/api/v3/business/parkings/detail?id=1' \
-H 'Authorization: Bearer \{your_access_token\}'

Get All Plans

Retrieves all available plans for a specific parking location.

Endpoint

POST /api/v3/business/parkings/plan

Request Body

{
"parkingId": 0
}
ParameterTypeRequiredDescription
parkingIdnumberYesThe ID of the parking location

Response

[
{
"id": 0,
"price": 0,
"place": 0,
"name": "string"
}
]
FieldTypeDescription
idnumberThe ID of the plan
pricenumberThe price of the plan
placenumberThe place of the plan
namestringThe name of the plan

Example

curl -X POST \
'https://api.parkup.cl/api/v3/business/parkings/plan' \
-H 'Authorization: Bearer \{your_access_token\}' \
-H 'Content-Type: application/json' \
-d '{
"parkingId": 1
}'

Error Responses

401 Unauthorized

{
"statusCode": 401,
"message": "Unauthorized"
}

This error occurs when:

  • The access token is invalid
  • The access token has expired
  • The access token is missing