Introduction

Bot

Version: 1.0.0

Authentication

apiKey	API Key

/PARKING/PRICES

GET

Summary: Retrieves parking place prices nearby specified geo.

Description:

HTTP Request

***GET*** /parking/prices

Parameters

Name	Located in	Description	Required	Type
id	query		No	string
latitude	query		No	number
longitude	query		No	number
address	query		No	string

Responses

Code	Description
400	Password and Confirm Password must match Must agree to Terms & Conditions
403	Unauthorized to create super user

/PUBLISH/MESSAGE

GET

Summary: publish message to fingerprintid

Description: On success, returns a token and user object

HTTP Request

***GET*** /publish/message

Responses

Code	Description
403	Invalid username and password combination User not found

/USER/{USERID}

GET

Summary: Get user

HTTP Request

***GET*** /user/{userId}

Responses

Code	Description
default	Successful

/WEBHOOKS/MESSENGER

GET

Summary: receives incoming messenger webhooks

Description: On success fulfills a messenger wehoook request

HTTP Request

***GET*** /webhooks/messenger

Responses

Code	Description
403	Invalid username and password combination User not found

POST

Summary: receives incoming messenger webhooks

Description: On success fulfills a messenger wehoook request

HTTP Request

***POST*** /webhooks/messenger

Responses

Code	Description
403	Invalid username and password combination User not found

/PARKING/PLACE/{ID}

GET

Summary: get parking place by id

Description:

HTTP Request

***GET*** /parking/place/{id}

Responses

Code	Description
default	Successful

/RESERVATION/{RESERVATIONID}/{USERID}

GET

Summary: Get a reservation

Description:

HTTP Request

***GET*** /reservation/{reservationId}/{userId}

Responses

Code	Description
400	error
403	error

/PARKING/PLACES/{ID}/MAP

GET

Summary: gets directions for the spot

Description:

HTTP Request

***GET*** /parking/places/{id}/map

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/PARKING/PLACES/{ID}/IMAGE

GET

Summary: Displays user's parking place image

Description:

HTTP Request

***GET*** /parking/places/{id}/image

Parameters

Name	Located in	Description	Required	Type
id	path		Yes	string

Responses

Code	Description
400	An error occured

/LICENSEPLATE

POST

Summary: post license plate number

Description: On success, returns a token and user object

HTTP Request

***POST*** /licenseplate

Responses

Code	Description
403	Invalid username and password combination User not found

/LOT

POST

Summary: gets nearby parking lots

Description:

HTTP Request

***POST*** /lot

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/PAYMENTS

POST

Summary: adds credit card payment info and reservation id to payment colelction

Description:

HTTP Request

***POST*** /payments

Parameters

Name	Located in	Description	Required	Type
body	body		No

Responses

Code	Description
400	error
403	unauthorized

/RESERVATION

POST

Summary: Creates a reservation

Description:

HTTP Request

***POST*** /reservation

Parameters

Name	Located in	Description	Required	Type
body	body		No

Responses

Code	Description
400	error
403	error

/SESSION

POST

Summary: Starts a session based on valid email and password.

Description: On success, returns a token and user object

HTTP Request

***POST*** /session

Parameters

Name	Located in	Description	Required	Type
body	body		No

Responses

Code	Description
403	Invalid username and password combination User not found

/USERS

POST

Summary: creates a user record

HTTP Request

***POST*** /users

Responses

Code	Description
default	Successful

/CALISONS/TWILIO

POST

Summary: Api for twilio calisons flow

HTTP Request

***POST*** /calisons/twilio

Responses

Code	Description
default	Successful

/DOCK/PLACES

POST

Summary: gets nearby dock spots

Description:

HTTP Request

***POST*** /dock/places

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/EV/PLACES

POST

Summary: gets nearby ev parking spots

Description:

HTTP Request

***POST*** /ev/places

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/PARKING/INSTRUCTIONS

POST

Summary: updates parking place with special instructions

Description:

HTTP Request

***POST*** /parking/instructions

Responses

Code	Description
400	error
403	unauthorized

PATCH

Summary: updates parking place with special instructions

Description:

HTTP Request

***PATCH*** /parking/instructions

Responses

Code	Description
400	error
403	unauthorized

/PARKING/PARKINGPICTURE

POST

Summary: sets parking image

Description:

HTTP Request

***POST*** /parking/parkingpicture

Responses

Code	Description
400	error
403	unauthorized

PATCH

Summary: sets parking image

Description:

HTTP Request

***PATCH*** /parking/parkingpicture

Responses

Code	Description
400	error
403	unauthorized

/PARKING/PLACE

POST

Summary: Creates a parking place record.

Description:

HTTP Request

***POST*** /parking/place

Responses

Code	Description
400	Password and Confirm Password must match Must agree to Terms & Conditions
403	Unauthorized to create super user

/PARKING/PLACES

POST

Summary: gets nearby parking spots

Description:

HTTP Request

***POST*** /parking/places

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/PARKING/SPACES

POST

Summary: Creates a parking space record.

Description:

HTTP Request

***POST*** /parking/spaces

Responses

Code	Description
400	Password and Confirm Password must match Must agree to Terms & Conditions
403	Unauthorized to create super user

/PUBLIC/PLACES

POST

Summary: gets nearby public parking spots

Description:

HTTP Request

***POST*** /public/places

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/QR/PLACES

POST

Summary: gets nearby dock spots

Description:

HTTP Request

***POST*** /qr/places

Responses

Code	Description
400	password and confirm password must match
403	Unauthorized to create super user

/USERS/MERCHANT

POST

Summary: Creates a user merchant account

Description:

HTTP Request

***POST*** /users/merchant

Responses

Code	Description
400	error
403	unauthorized

PATCH

Summary: Creates a user merchant account

Description:

HTTP Request

***PATCH*** /users/merchant

Responses

Code	Description
400	error
403	unauthorized

/WEBHOOKS/SLACK

POST

Summary: receives incoming sack webhooks

Description: On success fulfills a slack wehoook request

HTTP Request

***POST*** /webhooks/slack

Responses

Code	Description
403	Invalid username and password combination User not found

/WEBVIEWS/PAYMENT

POST

Summary: Sends user webview link to add payment

Description:

HTTP Request

***POST*** /webviews/payment

Parameters

Name	Located in	Description	Required	Type
body	body		No

Responses

Code	Description
400	error
403	unauthorized

/SESSION/LOG/MESSAGE

POST

Summary: logs a slack message

Description: on success, logs transcript from widget to the correct slack channel

HTTP Request

***POST*** /session/log/message

Responses

Code	Description
403	Invalid username and password combination User not found

Errors

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The kitten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.