From cd0d8fe9e5f058b8186c905c592c43e61bcec600 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Cruz?= Date: Sat, 9 Mar 2024 11:54:15 +0000 Subject: [PATCH] Add rate-limiting notice to REST API --- docs/rest-api.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/rest-api.md b/docs/rest-api.md index 1cac30e..1f62a98 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -13,6 +13,10 @@ Topper offers a REST API you can use to: - Get the list of supported payment methods per flow. - Create a pricing simulation for a specific flow. +:::info +The REST API has rate-limiting rules in place. If you plan to use the REST API extensively, reach out to us and we will whitelist the IPs you use to make requests to this API. +::: + ## OpenAPI documentation To make it easier to consume the REST API, there's an [OpenAPI specification](https://www.openapis.org/) available at https://api.topperpay.com/docs/json.