shun API
hearth public
0
Node
JavaScript
Python beta
Ruby beta
Shell
curl
Hey! Want to build awesome, scalable APIs like this one?
Sign up with StdLib today and build your own API or connect to others in seconds.
We hope you enjoy documentation for the shun hearth API on StdLib! This API can be used via the command line (shell), Node, Ruby, Python or as a generic HTTP call in any language. Check the code examples on the right associated with each API method for how to use this API in your language of choice.
API Description
No "description" field found in package.json
Loads landing page
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Adds a listing to the database
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
id
required
number
Phone number of listing poster
current value set to
enter a test value
type
required
string
Type of listing (food or shelter)
current value set to
enter a test value
description
required
string
A brief description of what is being offered (availability, times, etc)
current value set to
enter a test value
locationString
required
string
String detailing the location (to be fed into Google Maps API)
current value set to
enter a test value
Delete listing with given uuid
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
uuid
required
string
Unique identifier of listing to be deleted
current value set to
enter a test value
Handles all SMS Functions including receiving, parsing, and sending
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
sender
required
string
The phone number that sent the text to be handled
current value set to
enter a test value
receiver
required
string
The StdLib phone number that received the SMS
current value set to
enter a test value
message
required
string
The contents of the SMS
current value set to
enter a test value
createdDatetime
required
string
Datetime when the SMS was sent
current value set to
enter a test value
Loads the thank-you and delete page
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
uuid
required
string
Unique identifier corresponding to the listing
current value set to
enter a test value
Get and return listing object
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
uuid
required
string
Unique identifier of listing to be deleted
current value set to
enter a test value
Loads the Forms page
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Made with by the shun team with the help of StdLib.