Overview
Found Hero provides a simple yet powerful API to build and automate a lost and found solution into your management software.
The Found Hero API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.
We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret access token in any public website's client-side code).
API Keys
Before you start using our RESTful API services, you'll need to create an account on Found Hero to obtain an API key.
Once your account is approved, you can use the API key to authenticate with Found Hero API and then make HTTP requests.
To obtain an API key, do the following:
Login to your Found Hero account.
Go to the account settings page and then open the "API Keys" tab to view and manage your API keys.
Found Hero also provides a sandbox environment that you can use for development and testing. This environment acts the same way as production. All user accounts, passwords, and locations are independent of the production environment. To use our sandbox environment, you'll need to create a sandbox account as well.
Requests
The API accepts only HTTP requests with Content-Type set to application/json and a JSON body depending on the operation to be performed. The Found Hero API is served over HTTPS and unencrypted HTTP connections are not supported.
For the production environment, all HTTP requests should use the following base URL:
If you are using the Found Hero API within the sandbox environment, use the following base URL:
Responses
All API requests return a JSON-encoded response with Content-Type set to application/json. If the request is successful, the HTTP status code returned is 200 and the JSON content contains appropriate result according to the operation.
For a typical HTTP request, the returned JSON object has the following properties:
Property
Type
Description
status
boolean
required
A true or false value indicating the outcome of the operation.
message
string
optional
A human-readable string that provides additional information about the outcome of the operation.
data
object
optional
The actual JSON content containing the result of the operation.
Support
If you encounter any issue with the API, have any questions, or want to share your feedback, please send us an email at hello@joinfoundhero.com.
Last updated