Co je webhook?

S webhookem dostaneš okamžitě zprávy a upozornění do tvé aplikace. Začni zadáním webhook URL pro svou aplikaci, přihlas se k tématům a ověř webhook. Můžeš to udělat úpravou své aplikace a kliknutím na kartu webhook. V tomto záložce uvidíš i dostupná témata, na která se můžeš přihlásit.

Provoz webhook oznámení vyžaduje u tvé aplikace oprávnění Číst oznámení.

Autentizace

K autentizaci webhook požadavků, abys mohl/a ověřit, zda se jedná o platný požadavek z platformy Cryptohopper, použij hlavičku X-Hub-Signature v požadavku. X-Hub-Signature bude sha512 hashovaná řetězec payloadu s aplikačním tajemstvím jako klíčem.

Webhook formát

Webhook zveřejňuje platná data v tomto formátu:

{
    "app_id": 123,
    "type": "messages",
    "messages": [
    	{
            "type": "trade_completed",
            "title": "Hop completed for BTC",
            "message": "Your order has been successfully filled.",
            "data": {"coin":"BTC", ... }
    	},
        {...}
    ]
}

Validace

Webhook potřebuje ověření, když ho chceš uložit. Pro ověření webhook musí vrátit HTTP status code 200 a musí vygenerovat stejnou ověřovací kód, jaký si zadal do formuláře webhooku.

Zpráva o validaci JSON vypadá takto, ujistěte se, že vygenerujete stejný ověřovací kód, jaký jste zadali do formuláře webhooku.

{
    "app_id": 123,
    "type": "validate",
    "messages": []
}

PHP Příklad

<?php

$app_secret = 'ENTER_YOUR_APP_SECRET';
$verification_code = 'MY_VERIFICATION_CODE';

$requestBody = file_get_contents('php://input');
$headers = getallheaders();
$headers = array_change_key_case($headers, CASE_UPPER);
$json = json_decode($requestBody, true);

$signature = hash_hmac('sha512', $requestBody, $app_secret);

if($signature == $headers['X-HUB-SIGNATURE']){
	//valid webhook request
	if($json['type'] == 'validate'){
		// validate webhook
		echo $verification_code;
	}elseif($json['type'] == 'messages'){
		// receive messages
		print_r($json['messages'], true);
	}else{
		// unkown type
		echo 'Unkown webhook message type.';
	}
}else{
	//invalid signature
	echo 'Invalid signature.';
}
?>