Skip to content

Commit 52eaae0

Browse files
committed
add API architecture diagram
1 parent 6cccf52 commit 52eaae0

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

Database/api.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ airtable limits the API to 5 requests per second and suggests using a caching se
1111
using a GCP f1-micro instance that should theoretically not cost money (or cost very little) we have set up such a caching server at https://api.vacfind.org.
1212

1313
### Caching server architecture/setup
14-
the caching server uses caddyserver.com to provide HTTPS, varnish to provide the caching, and stunnel as an HTTPS client to make requests to Airtable's API because varnish doesnt support HTTPS or seemingly remote backends very easily.
14+
![VacFind API Data flow diagram](../static/API-Architecture.png)
15+
16+
The caching server uses caddyserver.com to provide HTTPS, varnish to provide the caching, and stunnel as an HTTPS client to make requests to Airtable's API because varnish doesnt support HTTPS or seemingly remote backends very easily.
1517

1618

1719
To be totaly honest, I dont think there is anything about our caching server that limits it to being used for just our airtable bases, so theoretically anyone can use their own base ID and APIkeys to read (not sure how the caching will interact with attempts to write. This may require more configuration) from their own airtable bases.

static/API-Architecture.png

34.4 KB
Loading

0 commit comments

Comments
 (0)