ApiBundle provides a set of Rest APIs which enable you to go quickly and build your powerful apps without wasting your time re-inventing the wheel. All our apis are highly secured and provided through HTTPS endpoint. Our apis are very intuitive and therefore, any developer or not can easily use it.
ApiBundle uses apikey to authenticate each request. You can simply pass it through params in your GET request.
So if not done already, subscribe to get a before getting further so that you could easily test it along.
https://api.apibundle.io
We take error handling into serious consideration, that's why we have a dedicated subject for it. We use both standard HTTP status codes and business messages to indicate the success or failure of a request. Successful requests will receive a 200 response code, while responses with a 40x or 500 indicate a failure.
Despite the HTTP status code, any error message has the following structure as response
| Field | Type | Description |
|---|---|---|
| type | string |
A string which indicate the type or nature of the error. Consult the next list to get a full list of type available |
| message | string |
The description of what made the request to fail |
| subtype Optional | string |
A more precise type of the error |
| field Optional | string |
The field which is causing the error |
Here is a list of all values of the field "type" previously define which are common to all APIs. The particular ones will be listed in the page of the concerned api
| Error type | HTTP code | Description |
|---|---|---|
| VALIDATION_ERROR | 400 | Happen when the request fields are not correct. In general, it also contains a field subtype and field which give more details about the issue |
| BAD_REQUEST | 400 | A string which indicate the type or nature of the error. Consult the next list to get a full list of type available |
| QUOTA_REACHED | 400 | Appear when you have reach your monthly quota. In that case, you have to renew your credits. You can log in and go to the section "Plans and credits" in the dashboard to renew |
| INVALID_API_KEY | 401 | When the provided key is not valid which means we do not recognize it at all. |
| API_KEY_NOT_FOUND | 401 | As it name says, it happens when by magic you forget to put your api key |
| NOT_FOUND | 404 | For not found route or service |
| INTERNAL_ERROR | 500 | The big boss error, it indicates a failure on our servers. Although these are rare, if you get one you can contact us at hello@apibundle.io and we'll quickly investigate to solve the issue |