API voor de Bijbel

Toegang met een sleutel

De API is kosteloos, maar niet vrij toegankelijk: elke aanroep draagt een persoonlijke sleutel. Zo blijft de server beschikbaar voor wie hem echt gebruikt.

Een sleutel vraagt u aan via uw account: maak een account aan of log in en gebruik op uw accountpagina het blok API-sleutel. Vermeld daarbij kort waarvoor u de API gebruikt. U hoort van ons zodra de sleutel klaarstaat; daarna staan de sleutel, de daglimiet en uw verbruik op uw accountpagina.

• Een sleutel is goed voor 2.000 aanroepen per dag. Hebt u structureel meer nodig, laat het ons dan weten.
• Roep de API aan vanaf uw eigen server. Zet de sleutel niet in openbare code en niet in de browser van uw bezoekers.
• Wilt u bij de teksten de bron vermelden, Statenvertaling via Online-Bijbel.nl? Dat stellen wij op prijs.

Wilt u het werk achter Online-Bijbel steunen? Dat kan via Steun Online-Bijbel.

De sleutel meegeven

Stuur de sleutel bij elke aanroep mee als header X-Api-Key. Kan uw toepassing geen headers zetten, gebruik dan de parameter key in de URL.

curl -H "X-Api-Key: uw-sleutel" "https://online-bijbel.nl/api.php?b=1&h=1&v=1"

Basis-URL

Alle aanroepen lopen via één endpoint:

https://online-bijbel.nl/api.php

Bijbelteksten ophalen

Om bijbelteksten op te halen heeft u het nummer van het bijbelboek nodig. Dat nummer vraagt u op met de aanroep Bijbelboeknummer ophalen hieronder. Een aanroep ziet er zo uit (de sleutel gaat als header mee):

https://online-bijbel.nl/api.php?b=1&h=1&v=1

b

bijbelboeknummer

h

hoofdstuknummer

v

versnummer(s)

Bij de parameter v mag u meerdere verzen opgeven. Losse verzen scheidt u met een komma, bijvoorbeeld vers 1 en 3: 1,3. Een aaneengesloten gedeelte geeft u met een streepje, bijvoorbeeld vers 5 tot en met 9: 5-9.

Bijbelboeknummer ophalen

De lijst met bijbelboeken en hun nummers vraagt u op via de parameter p:

https://online-bijbel.nl/api.php?p=boekenlijst

Antwoorden en meldingen

Een geslaagde aanroep geeft status 200 met de gevraagde verzen. Gaat er iets mis, dan krijgt u een melding in dezelfde XML-vorm als een vers, zodat uw toepassing hem kan tonen:

401

de sleutel is onbekend of ingetrokken

410

er is geen sleutel meegegeven, of de API is tijdelijk buiten gebruik

429

de daglimiet van de sleutel is bereikt; morgen is er weer ruimte

De teksten veranderen zelden; u mag een antwoord een dag bewaren.

De dagtekst op uw website

Beheert u de website van een kerk, school of vereniging? U kunt de dagtekst van vandaag op uw eigen site tonen: elke dag een kerntekst uit de Statenvertaling met een psalmvers om te zingen, in een rustige opmaak. Plaats daarvoor dit knipsel op uw pagina:

<iframe src="https://www.online-bijbel.nl/dagtekst/widget/" title="Dagtekst van Online-Bijbel" width="100%" height="450" style="border:0" loading="lazy"></iframe>

De widget vult de breedte van zijn plek en vernieuwt zichzelf elke dag. Kosten of voorwaarden zijn er niet; een verwijzing naar Online-Bijbel staat onderaan het blokje.