Биткоин-форвардинг API

Contents

Этот интерфейс генерирует новый уникальный биткоин-адрес, на который впоследствии клиент производит оплату. Этот адрес будет всегда мониториться и обрабатываться с бесконечным числом транзакций. И даже если транзакция на нём никогда не появится, мы всё равно будем мониторить этот адрес.

Вы можете генерировать новый адрес под каждый отдельный платеж или использовать этот адрес как привязанный к клиенту, например для пополнения баланса аккаунта клиента на своем сайте. То есть в том случае, если клиент использует этот адрес для повторной покупки одного и того же товара или ему нужно пополнить баланс своего телефона с помощью биткоинов.

Пожалуйста, помните, что микроплатежи в биткоинах крайне неэффективны из-за высокой комиссии сети!

Обязательно указывайте схему HTTP и HTTPS в URL-адресе для колбэка. Мы также поддерживаем колбэки в TOR сеть.TOR project logo сеть.

 

Example of Pay2KeyHash addresses:

Example of ScryptSig addresses:

 

Example of SegWit addresses:

 

Запрос:

Пример кода

  1. <?php
  2.     $my_address = "bc1qggg2ys8duv4qvnfgzng2p75m6ehklcmfygr9m4";
  3.     $my_callback_url = "http://example.com/callback?invoice_id=1234&secret=7j0ap91o99cxj8k9";
  4.     $api_base = "https://apirone.com/api/v1/receive";
  5.  
  6.     $curl = curl_init();
  7.     curl_setopt_array($curl, array(
  8.         CURLOPT_RETURNTRANSFER => 1,
  9.         CURLOPT_URL => $api_base . "?method=create&address=" . $my_address . "&callback=" . urlencode($my_callback_url)
  10.     ));
  11.     $response = curl_exec($curl);
  12.     $http_status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
  13.     curl_close($curl);
  14.  
  15.     if ($http_status_code == 200) {
  16.         $decoded = json_decode($response, true);
  17.         echo "Please send the payment to the following bitcoin address: " . $decoded["input_address"];
  18.     } else {
  19.         echo "Sorry, an error occurred: " . $response;
  20.     }
  21. ?>
  1. <?php
  2.   $my_address = "bc1qggg2ys8duv4qvnfgzng2p75m6ehklcmfygr9m4";
  3.   $my_callback_url = urlencode("http://example.com/callback?invoice_id=1234&secret=7j0ap91o99cxj8k9");
  4.   $data = file_get_contents("https://apirone.com/api/v1/receive?method=create&address=". $my_address. "&callback=" . $my_callback_url);
  5.   $respond = json_decode($data,true);
  6.   $address = $respond["input_address"]; // bitcoin address for customer payments
  7.   echo $address;
  8. ?>
  1. import requests
  2. import urllib
  3. my_address = 'bc1qggg2ys8duv4qvnfgzng2p75m6ehklcmfygr9m4'
  4. my_callback_url = urllib.parse.urlencode({"r":"http://example.com/callback?invoice_id=1234&secret=7j0ap91o99cxj8k9"})[2:]
  5. url = 'https://apirone.com/api/v1/receive?method=create&address=%s&callback=%s' % (my_address, my_callback_url)
  6. response = requests.get(url)
  7. print(response.text)
Метод и переменные:
Параметры Описание Обязательное поле Поэкспериментируйте со значениями
method=create

Метод генерации нового адреса для оплаты.

Обязательное поле
{address}
base58,
32 символа

Биткоин-адрес получателя
Биткоин-адрес Интернет-магазина, куда будет произведён форвардинг платежа

Обязательное поле
{callback}
текст,
=<1024 символа

Callback URL')}}
Интернет-магазине. Вы можете добавить дополнительные GET-параметры в эту ссылку, например ID клиента или заказа. Ссылка должна быть действительной.
Также ссылка должна быть в формате URLencoded или параметр с ней должен находиться в конце запроса. В противном случае вы не получите колбэк или получите его в неверном формате.

Обязательное поле
  Сбросить значения Сделать запрос
Результат выполнения:
{ "fee_percent": 1, "destination": "bc1qggg2ys8duv4qvnfgzng2p75m6ehklcmfygr9m4", "input_address": "1FEGJSLDJJ6oSuJwur3fCD7TtQbYUjBV4z", "callback_url": "http://example.com/addbalance.php?user=118" }

Успешное выполнение

При успешном выполнении запрос возвращает четыре параметра в JSON-формате::
Параметры Описание Тип (длина)
{fee_percent} Процент, который принимается за услугу. По умолчанию: 1 целое число
{destination} Биткоин-адрес Интернет-магазина, на который будет произведён форвардинг платежей. base58 (32 символа)
{input_address} Сгенерированный биткоин-адрес для оплаты покупателем. base58 (32 символа)
{callback_url} Ссылка на страницу колбэка вашего интернет-магазина. текст (=<1024 символа)
Пример результата выполнения:
{
    "fee_percent": 1,
    "destination": "bc1qggg2ys8duv4qvnfgzng2p75m6ehklcmfygr9m4",
    "input_address": "1FEGJSLDJJ6oSuJwur3fCD7TtQbYUjBV4z",
    "callback_url": "http://example.com/callback?invoice_id=1234&secret=7j0ap91o99cxj8k9"
}

Сообщение об ошибке

Сообщение об ошибке возвращается в текстовом формате, как показано ниже:
The supplied address is not a valid bitcoin address. — Указан неправильный биткоин-адрес.
The supplied callback URL is not valid. — Указана неправильная ссылка колбэка.
Wrong method. — Неправильный метод.
Not enough parameters. — Недостаточно параметров.
Incorrect address type.