Introduction
Getting started
featureOS API enables you to build custom applications to collect feedback, publish roadmap, and announce new features to your users. This API also provides access to our SSO, Webhooks, and Audit Trial for your featureOS account.
If you are already signed in with your featureOS account, the code samples, API keys, and other account specific keys. Enjoy building new integrations for your workflow with featureOS API.
Quick start
Before you start using featureOS, the content below will help you quickly understand the important terminologies and workings of featureOS API. We are working everyday to improve the functions of our API, and we can't wait to see what you would build on top of featureOS API.
API Keys
featureOS uses authentication to validate every API requests to our servers using the unique API key that is tagged to your account. Making an API request without authentication or using an invalid key will result in a 401 - API key is invalid response from our servers.
When you request a response from featureOS API servers with a valid API key, but without sufficient permissions, you will receive a 403 - Insufficient permissions response from our servers.
You can read more about our response types over here.
Please note that all the API requests should be made over HTTPS. Any request made over plain HTTP will not be honored by our servers.
You can view and manage your API keys in the featureOS Dashboard. A detailed article on how to generate a API key for your account is here for you to read through ↗
Securing your API Keys
Your API keys can perform read and write activities on your featureOS account. When in wrong hands, this could cause destructive actions that could cause data loss that could damage your account. To avoid being in such situations, it is important for you to keep your API keys very safe.
Always make sure that your API keys are not exposed to public. Do not commit your API keys to your code versioning repositories that others can access. If you are using GitHub, the platform performs automatic API key exposure alerts, but it will be too late if someone gets hold of the API key.
Should you be in the position where your API key was exposed, the best solution is to hit the kill-switch and regenerate the API key from your account and update your app accordingly.
Starting November 30, 2022, all our API keys will begin with hn_ as the default prefix.
Response Reference
featureOS API uses standardized HTTP response codes to authenticate and respond to API requests. The table below shows the response codes and their corresponding description.
| Status Code | Meaning | Description |
|---|---|---|
| 200 | Success | Request served successfully. |
| 400 | Bad request | Something is wrong with the request. |
| 401 | Unauthorized | Either the API key or JWT token is wrong. |
| 403 | Forbidden | Your account lacks permission. Are you an admin? |
| 404 | Not found | The resource you requested cannot be found |
| 418 | Teapot | The server cannot brew coffee, because it is a teapot. |
| 429 | Too many requests | Slow down. Ask for 418 and drink it. |
| 500 | Internal server error | Something is wrong with us. We're on it. |
| 503 | Service unavailable | Our servers could be down. We'll be right back. |
Requesting new APIs
We are on a mission to increase the number of customer-first companies in the world. Sharing our APIs with our customers is an integral part of our mission to make data available to the right people. If you find some feature's APIs missing, and if you think it will help you make your products better, we should talk. You can request new API feature requests here on our public feedback board.