Skip to content

Commit

Permalink
Proxy and Rate limit Update
Browse files Browse the repository at this point in the history
  • Loading branch information
jekuer committed Jul 16, 2024
1 parent 0804ed0 commit 9f7b4e5
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 4 deletions.
5 changes: 5 additions & 0 deletions src/api/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,8 @@ https://api.add-to-calendar-pro.com/v1
```

All following call schemes assume this base to be prepended.

## Rate Limiting

The API is rate limited at 80 requests per second.
If this does not work for your, please contact us and tell us about your case.
5 changes: 5 additions & 0 deletions src/de/api/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,8 @@ https://api.add-to-calendar-pro.com/v1
```

Alle folgenden Call-Schemata setzen voraus, dass diese Basis vorangestellt wird.

## Rate Limiting

Die API beinhaltet ein Rate Limit von 80 Requests pro Sekunde.
Sollte dir dies nicht ausreichen, sende uns bitte eine Nachricht, in der du uns deinen Fall beschreibst.
5 changes: 3 additions & 2 deletions src/de/integration/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ Du kannst jedoch stattdessen die unstyle-Version laden, um CSS-Daten zu sparen,

Ob du Links und Dateien über das Skript auf der Client-Seite generieren lassen oder ob du unseren Proxy-Service verwenden möchtest.

Im ersten Fall werden die Links zu den Kalendern direkt im Browser dynamisch generiert. Auch die ics-Datei wird auf diese Weise dynamisch erstellt. Dies ist der schnellste Ansatz (aus Sicht des Benutzers). Allerdings wird die ics-Generierung bei einigen Systemen blockiert und falls ein Kalenderanbieter offline geht oder interne Probleme hat, kann der Benutzer kein Event speichern. Die Verwendung unseres Proxys erfordert, dass Events mit einem Style verknüpft sind, bei dem die "Proxy"-Option aktiv ist.
Im ersten Fall werden die Links zu den Kalendern direkt im Browser dynamisch generiert. Auch die ics-Datei wird auf diese Weise dynamisch erstellt. Dies ist der schnellste Ansatz (aus Sicht des Benutzers). Allerdings wird die ics-Generierung bei einigen Systemen blockiert und falls ein Kalenderanbieter offline geht oder interne Probleme hat, kann der Benutzer kein Event speichern.
Bei Verwendung des Proxys werden Links und Dateien auf unserer Seite generiert und der Benutzer wird zuerst zu uns umgeleitet. Sollte etwas nicht funktionieren, können wir den Benutzer damit auch darüber informieren und Alternativen sowie Anleitungen anbieten. Dies ist daher der stabilere Weg, für den Benutzer aber etwas langsamer.

In diesem Fall werden Links und Dateien auf unserer Seite generiert und der Benutzer wird zuerst zu uns umgeleitet. Sollte etwas nicht funktionieren, können wir den Benutzer damit auch darüber informieren und Alternativen sowie Anleitungen anbieten. Dies ist daher der stabilere Weg, für den Benutzer aber etwas langsamer. Du kannst die Zwischenseiten anpassen, indem du einen Style mit einem Landingpage-Template verknüpfst.
Du kannst die Proxy-Einstellung über einen Style verwalten, den du mit dem Event (oder Event-Gruppe) verbindest. Wenn kein Style definiert ist, verwendet wir standardmäßig die Proxy-Option.

## Allgemeiner Workflow

Expand Down
6 changes: 4 additions & 2 deletions src/integration/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ However, you can load the unstyle version instead to save on css data you do not

If you want links and files to be generated via the script on the client side or whether you want to use our Proxy service.

The first case will generate the links to the calendar sites dynamically directly in the browser. It will also generate the ics file that way. This is the fastest approach (from a user's perspective). However, ics generation gets blocked at some systems and if a calendar provider goes offline or has interal problems, the user will not be able to save an event. Using our proxy requires events to be connected to a style with the "proxy" option active. In this case, links and files get generated on our side and the user gets redirected to to us first.
The first case will generate the links to the calendar sites dynamically directly in the browser. It will also generate the ics file that way. This is the fastest approach (from a user's perspective). However, ics generation gets blocked at some systems and if a calendar provider goes offline or has interal problems, the user will not be able to save an event.
With the proxy, links and files get generated on our side and the user gets redirected to to us first.
This way, when something does not work, we can tell the user about it and offer alternatives and guidance. It is more stable, but a little slower for the user.

This way, when something does not work, we can tell the user about it and offer alternatives and guidance. It is more stable, but a little slower for the user. You can customize this journey by linking a style to a custom landingpage template.
You can control this setting at a style, which you then link to your event or group. If no style is set, the proxy will be the default.

## General workflow

Expand Down

0 comments on commit 9f7b4e5

Please sign in to comment.