Integrace Ověř18.cz napřímo pomocí API
Informace k integraci pomocí vlastního API.
Umístění widgetu na vaší stránce
Pro vykreslení ověřovacího prvku na vaší stránce je nutné zahrnout potřebný zdroj JavaScriptu a div tag s názvem třídy over18 a atributem data-apikey .
Na místo, kde chcete, aby byl umístěn ověřovací prvek, vložte kód:
<div class="over18" data-apikey="VAS_API_KLIC"></div>
Parametr data-sitekey v uvozovkách nahraďte veřejným API klíčem, získaným pro konkrétní doménu. Kód musí být pro použití API zahrnut do formuláře mezi
<form>
a </form>
společně s ostatními prvky formuláře, které budete odesílat.Na konec HTML kódu stránky, kde se bude zobrazovat widget, před
</body>
vložte:<script async src="https://api.over18.cz/clientApi.js"></script>
Komunikace API a ověření výsledku
Pokud uživatel odešle formulář na vašem webu a provedl ověření, získáte hodnotu výsledku ověření v parametru over18-response. Pokud uživatel neprovedl ověření nebo při ověření nastala chyba, pak není tento parametr předáván.
Povinné parametry pro volání API:
URL pro volání API: https://api.over18.cz/result/ [VAS_API_KLIC] / [OVER18-RESPONSE]
[VAS_API_KLIC]
- API klíč vaší aplikace, naleznete v administraci.
[OVER18-RESPONSE]
- Výsledek ověření, bude odeslán jako hodnota formuláře.
Odpověď API je ve formátu JSON a při správném volání obsahuje:
[status]
- INT
0
- Neplatné ověření
1
- Úspěšně ověřen věk, splňuje 18+
2
- Věk ověřen, nesplňuje 18+
[text]
- STRING
[date]
- DATETIME
[service]
- STRING
[response]
- STRING
Příklad použití při odeslání formuláře:
Zkontrolujeme získanou hodnotu výsledku:
if (!empty($_POST['over18-response'])){
...
}
Odešleme požadavek na API:
$result = json_decode(file_get_contents('https://api.over18.cz/result/VAS_API_KLIC/'.$_POST['over18-response']));
Zpracování odpovědi API:
if (isset($result->status)){
if ($result->status == 1){
//priklad uspesneho overeni, bude vracen status 1
}
}