Repository navigation
API Reference
Welcome to the CrowdWide API documentation.
This page introduces the API and explains how developers can find endpoint details.
For the complete list of endpoints, request parameters, responses, and examples, consult the API documentation in the main repository.
Look for the API documentation file in the repository before making API requests.
For local development, the application may be available at:
http://localhost:3000
The actual API base path depends on the route configuration in the application.
Some endpoints may require an authenticated session.
Before using an endpoint, check its implementation to determine:
- Whether authentication is required.
- Which HTTP methods are supported.
- What request data is expected.
- What response format is returned.
- How errors are reported.
Common HTTP methods include:
| Method | Typical purpose |
|---|---|
GET |
Retrieve information |
POST |
Submit data or create a resource |
PUT |
Replace a resource |
PATCH |
Update part of a resource |
DELETE |
Remove a resource |
These are general HTTP conventions. Not every method is necessarily supported by CrowdWide.
When an API request fails, inspect the HTTP status code and response body.
Common HTTP status codes include:
-
200 OK— Request succeeded. -
201 Created— A resource was created. -
400 Bad Request— The request was invalid. -
401 Unauthorized— Authentication is required or invalid. -
403 Forbidden— The operation is not permitted. -
404 Not Found— The requested resource was not found. -
500 Internal Server Error— An unexpected server error occurred.
Actual responses depend on the endpoint implementation.
Before integrating with an endpoint:
- Start CrowdWide using the Getting Started guide.
- Find the endpoint and its required parameters in the source code.
- Check whether authentication is required.
- Send a test request using valid data.
- Verify the response and error handling.
Only test against systems you are authorized to use.