The Linkfire API is based on REST principles. Data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint.
Where possible, the API strives to use appropriate HTTP verbs for each action:
| Verb | Description |
|---|---|
| GET | Used for retrieving resources. |
| POST | Used for creating resources. |
| PUT | Used for changing/replacing resources or collections. |
| DELETE | Used for deleting resources. |
All responses come in standard JSON format. The linkfire API is served over HTTPS to ensure data privacy; HTTP is not supported.
Linkfire uses conventional HTTP response codes to indicate the success or failiure of an API request. Generally, codes in the 2xx range indicate success, codes in the 4xxrange indicate an error with the request on the client-side (e.g., a required parameter was omitted), and codes in the 5xxrange indicate an error with Linkfires's servers.
| Status Codes | Description |
|---|---|
| 2XX – Success | Everything worked as expected. |
| 400 – Bad Request | Often caused by missing a required parameter or malformed JSON/CSV/XML data |
| 401 – Unauthorized | No valid API credential provided or header is completely missing. |
| 403 – Forbidden | Likely not authenticated against the correct scope. |
| 404 – Not Found | The requested item doesn't exist. |
| 415 – Unsupported Media Type | Request Payload is in an unsupported format. |
| 5XX – Server Errors | Something went wrong on our end. |
Linkfire System Status
You can always check the available of Linkfire's servers in real-time on our status page.