URL, method, error conventions ('GET', 'POST', 'PUT', 'DELETE')

This lowers the entry threshold, simplifies integrations, and allows the system to scale without chaos.
Conventions of URL and HTTP methods
Method | Purpose | Sample Query |
---|---|---|
'GET' | Get resource | 'GET/users/42' |
'POST' | Create a new resource | 'POST/users' |
'PUT' | Full Resource Update | 'PUT/users/42' |
'PATCH' | Partial Resource Update (Opt.) | `PATCH /users/42` |
'DELETE' | Delete resource | 'DELETE/users/42' |
Use plural ('/users', '/devices', '/games')
Nested entities are described as a hierarchy ('/users/42/sessions')
All requests go via HTTPS
Error handling standards
Code | Value | Sample Message |
---|---|---|
'400' | Invalid request | 'Missing required field: email' |
'401' | Unauthorized | 'Invalid token or expired session' |
'403' | Access denied | 'Access denied to resource' |
'404' | Not found | 'User with ID 42 not found' |
'409' | Conflict (e.g. duplication) | 'Email already in use' |
'422' | Validation error | 'Field' age 'must be a number' |
'500' | Internal Server Error | 'Unexpected exception, contact support' |
Error response structure:
- ```json
- {
- “ error “ : {
- “ code “ : 400,
- “ message “ : “ Missing required field: email “ ,
- “ details “ : {...}
- }
- }
- ```
Developer Benefits
Quick understanding of API logic without unnecessary documentation
Unified approach to all modules and entities
Easy debugging and logging thanks to standard codes and formats
Compatibility with OpenAPI/Swagger, Postman, SDK autogeneration
Simplifies support, testing, and CI/CD
Where especially important
Open or Partner API Platforms
Projects with multiple development teams
Microservices architecture or API-first approach
Systems with many entities and interactions
Uniform conventions make the API reliable, understandable and convenient. We adhere to the best REST practices so that each integration takes place quickly, without misunderstandings and with maximum predictability.
Contact Us
Fill out the form below and we’ll get back to you soon.