Document default API rate limits#250
Open
gtsoi wants to merge 1 commit into
Open
Conversation
Add a Rate Limits page to the Overview section covering the default per-partner limits (100/sec, 500/min, 10,000/hour), the 429 response shape, the X-RateLimit-* / Retry-After headers, and backoff guidance. Register it in toc.json after Versioning. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a Rate Limits page to the Overview section of the Developer Center (https://developers.vendasta.com/platform), reminding integrators about the default rate limits on the Vendasta APIs.
Why
The default limits are enforced by the api-gateway but were not documented anywhere customer-facing, so partners only discovered them by hitting a
429. The only prior mention was a one-line note in the CRM guide.Contents
The page documents:
429 Too Many Requestsresponse shape.X-RateLimit-Limit/Remaining/Used/ResetandRetry-Afterheaders.Registered in
toc.jsonunder Overview, after Versioning.Source of the numbers
Values match
DefaultLimitin api-gateway (internal/middleware/ratelimit.go): 100/sec, 500/min, 10,000/hour. Rate limiting is namespaced per partner ID. Note: a handful of high-volume partners have negotiated higher limits, which is covered by the "Unless a higher limit has been arranged" wording.🤖 Generated with Claude Code