diff --git a/_includes/build/best_practices.html b/_includes/build/best_practices.html new file mode 100644 index 0000000..2611682 --- /dev/null +++ b/_includes/build/best_practices.html @@ -0,0 +1,7 @@ +
+ There are many ways to accomplish the same objective within BCDA, and following our list of best practices can ensure optimal performance for all consumers of BCDA. +
+ +Occasionally, when interacting with BCDA, you might encounter responses with a status code of 429 Too Many Requests
. This can happen for two main reasons:
BCDA assigns 429 response codes based on two independent criteria:
+ +Regardless of the reason, BCDA will include a Retry-After header in its response. It's considered best practice to wait until the period specified in this header has elapsed before making further requests. This ensures your client can adapt without manual intervention, even if the rate-limiting parameters change.
+ +Concerning duplicate jobs, BCDA defines them as attempts to recreate a job already marked as "In-Progress". For reference, you can view both existing and past jobs by accessing the job history endpoint at /jobs
.