Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. Developer
  • Welcome to the developer portal
  • Get your token
  • Rate-Limiting
  • API-Reference
    • Authentication
      • AuthenticationService
        • /auth/login
        • /auth/refresh
        • /auth/manage/info
        • /auth/manage/info
    • Information about your club
      • Club
        • Gets the information of the club.
        • Changes the information of the club.
        • Gets the logo of the club.
        • Changes the logo of the club.
      • Department
        • Retrieves all departments for the current club.
        • Creates a new department.
        • Retrieves a specific department by its ID.
        • Deletes a specific department by its ID.
        • Modifies an existing department.
        • Retrieves the settings for the departments.
        • Updates the settings for the departments.
      • Forms
        • Retrieves the membership form for the club.
        • Modifies the membership form for the club.
        • Retrieves the cancellation form for the club.
        • Modifies the cancellation form for the club.
      • Membership
        • Retrieves all memberships for the current club.
        • Creates a new membership.
        • Retrieves a specific membership by its ID.
        • Deletes a specific membership by its ID.
        • Modifies an existing membership.
      • CustomField
        • Retrieves all custom fields for the current club.
        • Creates a new custom field.
        • Retrieves a specific custom field by its internal name.
        • Deletes a specific custom field by its internal name.
        • Modifies an existing custom field.
    • Submits
      • Cancellations
        • Get cancellation by id
        • Delete cancellation
        • Create new cancellation
        • Get cancellation PDF
        • Get cancellation CSV
        • Confirm cancellation
      • Changes
        • Create a new change request
        • Get change request by ID
        • Delete change request
        • Get change request PDF
        • Get change request CSV
        • Confirm change request
      • Memberships
        • Creates a new membership application
        • Retrieves a membership application
        • Deletes a membership application
        • Exports a membership application as PDF
        • Exports a membership application as CSV
        • Confirms a membership application
      • Submits
        • Retrieves all submissions.
        • Accepts a submission.
        • Denies a submission.
    • Reporting
      • Dashboard
        • Gets the count of new memberships.
        • Gets the count of new changes.
        • Gets the count of new cancellations.
        • Gets the membership chart data.
  1. Developer

Rate-Limiting

To ensure fair usage and protect the performance of the Vereinsantrag platform, we enforce rate limiting for all incoming API requests.

⏱️ Rate Limit Policy#

Each client is subject to the following limits:
20 concurrent requests (max number of requests handled simultaneously)
2,000 requests per 10-minute window
These rules apply globally and are automatically enforced by the system.

Limit TypeValue
Concurrent Requests20
Fixed Window Limit2,000 requests per 10 minutes

🚫
If your client exceeds any of these limits, the API will respond with:
HTTP 429 Too Many Requests
A Retry-After header (in seconds) indicating how long to wait before retrying.

🔁 Handling Rate Limit Responses#

When your client exceeds the allowed limits, you'll receive a 429 Too Many Requests response. In this case:
Respect the Retry-After header to determine when to try again.
Avoid retrying immediately without a delay — this may lead to further rejections.
If possible, implement exponential backoff or queuing in your client application.

Example 429 Response#

HTTP/1.1 429 Too Many Requests
Retry-After: 120
Content-Type: text/plain
Too many requests. Please try again later.

📌 Notes#

Limits apply per authenticated user (if available), or fall back to the request host if unauthenticated.
These limits are global, affecting all routes in the API.
No queuing is implemented — excess requests are immediately rejected.
If your use case requires higher limits, feel free to contact us at info@vereinsantrag.de.
Previous
Get your token
Next
/auth/login
Built with