2 Öffentliche API
Benjamin Hartmann edited this page 2 years ago

Benutzung

Frage einen API Key an. Gehe dazu auf https://awesomebible.de/kontakt und schreibe uns, wo und wofür du den API Key verwenden möchtest. Beispiel:

Name: Max Mustermann
 
E-Mail: max.mustermann@mustermail.de
 
Nachricht: 
Hallo. Ich würde gerne einen API-Key für awesomeBible Verse bekommen.
Ich verwende awesomeBible Verse in meiner App. (https://the.appstore.com/app/maxes-coole-app).
Die App sendet alle 2 Sekunden einen API-Call und ich habe über 1 Million Nutzer.

Die API-Anfrage sollte so geformt sein: https://verse.awesomebible.de/api/?key=DEIN_API_KEY&location=BIBELBUCH_KAPITEL_UND_VERS

Beispiel: https://verse.awesomebible.de/api/?key=api-key&location=Offenbarung4,11

Zurück würde dann folgendes kommen:

{"status":"200", "content":"https://codeberg.org/awesomeBible/verse/raw/branch/master/img/1.jpg"}

Alternativ kann noch zwischen den Formaten json und img gewechselt werden.

Beispiel: https://verse.awesomebible.de/api/?key=api-key&location=Offenbarung4,11&output=image

Standardmäßig gibt die API immer eine JSON Antwort.

Status Codes

Die API liefert bei jeder Antwort einen Status mit.

Statuscode Status
200 OK
400 Der API-Key ist falsch.
404 Keine Parameter angegeben.
Table of Contents