​
Base URL & Request Format

  • Base URL: All API endpoints are accessed securely via our base URL: 
    https://api.pixxel.space
  • Request Headers: Every API request must include the following headers:
    • Content-Type: application/json
    • Authorization: <YOUR_API_KEY>
  • JSON Format: Our API accepts and returns data in JSON format. Ensure that all requests are properly formatted as JSON.

​
Testing the API

  • Ping the Server: Use the /ping endpoint to check if the API is reachable. A successful response will return a simple message indicating that the server is active.

​
Error Handling & Best Practices

  • Error Codes: Our API returns standardized HTTP status codes along with detailed error messages. For example:
    • 400 Bad Request: Indicates invalid input or malformed requests.
    • 403 Forbidden: Authentication errors or insufficient permissions.
    • 500 Internal Server Error: Issues on the server side.
  • Tips for Success:
    • Verify that all required parameters are included.
    • Use the provided sample request bodies as a starting point.
    • Consult the Developer Docs for practical implementation guides and real-world examples.