From d27473324e25b068bc6525afb4e19ff1eabecf53 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Mon, 12 Aug 2019 13:30:43 +0200 Subject: [PATCH] fix(core): update --- markdown/api.md | 8 -------- markdown/endpoints.md | 18 ++++++++++++++++++ markdown/limitations.md | 1 + mkdocs.yml | 1 + 4 files changed, 20 insertions(+), 8 deletions(-) delete mode 100644 markdown/api.md create mode 100644 markdown/endpoints.md diff --git a/markdown/api.md b/markdown/api.md deleted file mode 100644 index 9e1e855..0000000 --- a/markdown/api.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Tools ---- -# AWMP - Tools -In order to simplify AWPM certification there are some check tools available - -## checkspec -checkspec automatically checks some technical parts of the awpm-spec like brandfile-spec consistency across projects. diff --git a/markdown/endpoints.md b/markdown/endpoints.md new file mode 100644 index 0000000..17e8ed8 --- /dev/null +++ b/markdown/endpoints.md @@ -0,0 +1,18 @@ +# API + +## Balance Endpoint +```text +https://balance.api.global +``` +api.global uses a balancing endpoint to balance clients between dynamic workers. The balance endpoint will assign you a dynamic endpoint,a secret that proves you got assigned that endpoint, a max timeframe that the worker is guranteed to be available and a max idle timeframe between requests, before your spot is given to the next api client balancing applicant. You can always come back here and ask for a new worker assignment. + + +## Async Endpoint +```text +https://async.api.global +``` +For requests that are not sensitive for timely execution there is a async endpoint, that will schedule an request for "later point in time" exection. Any requests going there need to register a webhook within their account for transmitting responses in an asynchronious fashion. + +## Worker Endpoints +[4chd76gf].api.global +Worker endpoints \ No newline at end of file diff --git a/markdown/limitations.md b/markdown/limitations.md index 7b3bd5a..58701c7 100644 --- a/markdown/limitations.md +++ b/markdown/limitations.md @@ -4,6 +4,7 @@ api.global is deplyoing a few hard limitations on a per account basis: * 1 million API requests per hour * 12 million API requests per day +* max of 10 assigned workers at any given time. !!! hint running into one of those limitations will result in a 429 status code with an info of when to try again attached as json payload in the response. diff --git a/mkdocs.yml b/mkdocs.yml index e218add..a910973 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -89,5 +89,6 @@ nav: - Overview: - Getting Started: index.md - Limitations: limitations.md + - Endpoints: endpoints.md - NodeJS: nodejs.md - Support: support.md