API-Dokumentation

Die Verwendung dieser API ist auf Programmierer und Personen mit fortgeschrittenen technischen Kenntnissen beschränkt. Jede Funktion, die Sie über die API ausführen möchten, kann auch über die Weboberfläche ausgeführt werden. Wenn Sie also technisch nicht versiert sind, sollten Sie die Weboberfläche verwenden.

Um sich bei unserer API zu authentifizieren, benötigen Sie das Auth-Token. Bitte beachten Sie, dass Sie diese Informationen nur sehen, wenn Sie auf der Website eingeloggt sind, und dass diese Daten nur für Ihr Konto gelten und nicht personenbezogen sind. Geben Sie diese Daten nicht an Personen außerhalb Ihrer Organisation weiter. Alle Ihre Anrufe müssen Folgendes enthalten:

Sie müssen eingeloggt sein, um diese Werte zu sehen Klicken Sie hier.

Unsere API ist im REST-Format, also unabhängig von der zu verwendenden Sprache. Anrufe werden immer über den folgenden Endpunkt getätigt:

https://acumbamail.com/api/1/(nombreFuncion)/

Und an diesen Endpunkt werden die Eingabeparameter übergeben. Da in den meisten Fällen Änderungen an den in der Datenbank gespeicherten Daten vorgenommen werden, empfehlen wir die Verwendung von POST, obwohl wir auch die Möglichkeit haben, GET-Aufrufe zu unterstützen.

Alle Funktionen geben zusätzlich zu den Daten, die sie als Antwort auf die Anfrage zurückgeben können, auch einen html-Statuscode zurück, den wir erfassen können. Für jede Situation gibt es einen anderen Code, und zwar den folgenden:

• Statuscode

• 200

  Die Konsultation verlief gut

• 201

  Die Daten wurden korrekt geändert

• 400

  Falsche Anfrage: Ein Argument ist falsch

• 401

  Nicht autorisiert, der Authentifizierungsprozess wurde falsch durchgeführt

• 429

  Zu viele Anfragen an eine Funktion in einer bestimmten Zeitspanne

• 500

  Auf dem Server ist ein Fehler aufgetreten. Lassen Sie es uns wissen, damit wir das Problem beheben können

In manchen Fällen wird ein Wörterbuch als Eingabeparameter für Methoden verlangt. Bei POST-Aufrufen müssen alle Parameter als Formulardaten in den Body aufgenommen werden. Um ein Wörterbuch in einem GET-Aufruf zu kodieren, würde ein Beispiel lauten:

https://acumbamail.com/api/1/(nombreFuncion)/?dict[key]=value&dict[key1]=value1&dict[key2]=value2

Und an diesen Endpunkt werden die Eingabeparameter übergeben. Da in den meisten Fällen Änderungen an den in der Datenbank gespeicherten Daten vorgenommen werden, empfehlen wir die Verwendung von POST, obwohl wir auch die Möglichkeit haben, GET-Aufrufe zu unterstützen.