Errors

Resumen

LiGo uses conventional HTTP response codes to indicate the success or failure of an API request. In general: - Codes in the 2xx range indicate success - Codes in the 4xx range indicate an error from the provided information (e.g., missing required parameter, invalid authentication) - Codes in the 5xx range indicate server errors

Error Response Format

When an error occurs, the API returns a JSON response with the following: - error error code that identifies the specific type of problem that occurred - message field containing a description of what went wrong - documentation containing a URL to the documentation of the resource

{
  "error": "Error code specifiying what problem occurred",
  "message": "Error message describing what went wrong",
  "documentation": "URL pointing to the documentation of the resource"
}

Error Codes

List of machine-readable error codes:

HTTP Status Codes

Common Error Examples

{
  "error": "INVALID_INPUT", 
  "message": "'post_text' is missing in the request body", 
  "documentation": "https://ligosocial.com/api-documentation"
}

{
  "error": "INVALID_API_KEY", 
  "message": "Invalid API key", 
  "documentation": "https://ligosocial.com/api-documentation"
}

{
  "error": "RESOURCE_NOT_FOUND", 
  "message": "No posts found", 
  "documentation": "https://ligosocial.com/api-documentation"
}