API

Authentication

GuruSup API uses API Keys to authenticate requests. You can view and manage your API keys in the Gurusup Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

GuruSup uses conventional HTTP respone to indicate success or failure of every API requests.

Add two headers to requests with the values provided by GuruSup:

1 curl https://api.gurusup.com/api/v1
x-API-KEY
X-API-USERNAME

Error

GuruSup uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided ( e.g., a required parameter was omitted, a charge failed, etc.) Codes in the 5xx range indicate an error with GuruSup's servers (these are rare).

HTTP Status Code Summary

GuruSup returns meaningufl HTTP status codes:

Code: 200
Status: OK
Semantics: The request was successful, and the JSON response includes the resource or data that you requested.

Code: 201
Status: Created
Semantics: A new resource (e.g., a ticket or message) was successfully created.

Code: 202
Status: Accepted
Semantics: The request to update a resource was accepted and successfully processed.

Code: 204
Status: No Content
Semantics: The request to delete a resource was successful, but no additional data is returned in the response.

Code: 400
Status: Bad Request
Semantics: The request is invalid due to malformed syntax, a missing required parameter, or an invalid parameter value.

Code: 401
Status: Unauthorized
Semantics: The request is missing or using an incorrect API key. Ensure the API key in the header is valid.

Code: 403
Status: Forbidden
Semantics: Access denied. The request is trying to access a resource you do not have permission to access.

Code: 404
Status: Not Found
Semantics: The requested resource does not exist or could not be found in the system. Verify the resource ID or endpoint.

Code: 500
Status: Internal Server Error
Semantics: An unexpected error occurred on GuruSup's side. Contact support if the issue persists.

Code: 503
Status: Service Unavailable
Semantics: The GuruSup service is temporarily unavailable, possibly due to maintenance. Try again later.

Final Notes

This documentation is designed to give you everything you need to start using the GuruSup API's Resources endpoints effectively. For further questions, contact support@gurusup.com.