Документация

Быстрый старт

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

Чтобы начать, вам необходимо зарегистрироваться в Biwse.

Шаг 1: API Токен

После регистрации Учетной записи вы можете создать приложение. Приложение - это ваш кошелек, к которому вы можете получить доступ через наш API. Вы можете создать столько приложений, сколько Вы захотите, чтобы руководить разными проектами. Токен API относится к конкретному приложению, что позволяет более легко управлять токенами в проектах.

Создать новый токен можно на странице приложения.

Запись: Сохраните токен в надежном месте, это позволит вам получить доступ к Biwse API и тратить средства.

Tip: Вы можете выполнять запросы API с помощью test token test_token_I6Ims4a2dvNXJLUzMy, и он даст вам ответы с тестовыми данными.

Шаг 2: Страница счета

С помощью токена API можно создать новый адрес:

Пример Запроса:

                                
curl -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
https://biwse.com/api/v1/new_address

# Response:
# {"status": true, "address": "YOUR_NEW_ADDRESS"}
                            

Используйте сгенерированный адрес для создания страницы счета. Также нужно указать сумму, которую вы хотите получить:

Пример Запроса:

                                

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"address": "ADDRESS",
"amount": 0.001
}' \
https://biwse.com/api/v1/new_invoice

# Response:
#{"status":true,"id":"invoice_id...","url":"https://biwse.com/invoice/invoice_id..."}
                            

Вы можете перейти по ссылке из ответа и увидеть, что ваша страница счета готова к работе!

Что дальше?
Клиент Biwse РНР

Библиотека PHP Biwse предоставляет доступ к API Biwse.

Установите пакет с помощью:


composer require biwse/biwse-php
                            

Пакет необходимо настроить с помощью токена доступа приложения, который доступен на панели Biwse

Настройка клиента:


use Biwse\Client\Biwse;
// create API client using your token
$app = new Biwse("YOUR_TOKEN");
                            
Получить Баланс

$res = $app->balance();
$total = $res->total;
$confirmed = $res->confirmed;
                            
Новый Адрес

$res = $app->newAddress("https://your_cllback_link.com");
$address = $res->address;
                            
Отправить средства

$res = $app->send("ADDRESS",0.001);
$txHash = $res->tx_hash;
                            
Множественная отправка средств

$res = $app->multiSend([ "payments" =>[
            ["address" => "ADDRESS_1","amount" => 0.001],
            ["address" => "ADDRESS_2","amount" => 0.001],
        ]
    ]);
$txHash = $res->tx_hash;
                            
Новый счет

$res = $app->newInvoice("YOUR_ADDRESS",0.1);
$invoiceUrl = $res->url;
                            
Biwse JS Клиент

Библиотека Biwse JS предоставляет доступ к API Biwse.

Установите пакет с помощью:


npm install biwse-js --save
                            

Пакет необходимо настроить с помощью токена доступа приложения, который доступен на панели Biwse

Настройка клиента:


import BiwseAPI from 'biwse-js' 
// create API client using your token
const app = new BiwseAPI('your_token...')
                            
Новый Адрес

опустить аргумент callback (см. справочник по API )


const { address, status } = await app.newAddress('https://your_address...')
                            
Новый счет

const response = await app.newInvoice('btc_address...', 0.001)
const { status, id, url } = response
                            
Получить Баланс

const response = await app.balance()
const { total, confirmed, status } = response
                            
Отправить средства

const { tx_hash, status } = await app.send('btc_address...', 0.001)
                            
Множественная отправка средств

const { tx_hash, status } = await app.multiSend({payments: [
	{address: 'btc_address_1', amount: 0.001},
	{address: 'btc_address_2', amount: 0.001},
]})
                            
Как начать

Во-первых, вам понадобится ваш API-ключ, который мы предоставляем для кошельков. Вы можете получить ключи в настройках Вашего приложения. Вы должны использовать API-ключ во взаимодействии с biwse.com. Все запросы должны содержать эти заголовки:

Content-Type:application/json
Accept:application/json
Authorization:Bearer YOUR_TOKEN

YOUR_TOKEN – ключ, полученный в настройках приложения.


General Invoice

Во-первых, вам понадобится Ваш идентификатор клиента, который мы предоставляем для страницы merchant. Вы можете получить идентификатор клиента в настройках страницы merchant.

Этот метод позволяет создавать страницы накладных, на которых пользователи могут выбирать валюту для оплаты.

Тип запроса:POST
URL:/general_invoice/CLIENT_ID

Для получения страницы счета необходимо отправить запрос POST на этот адрес - https://biwse.com/general_invoice/CLIENT_ID

Пример Запроса

                                
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"amount_usd": 100,
"invoice_number": "#001",
"callback_link": "https://yoursite.com"
}' \
https://biwse.com/general_invoice/CLIENT_ID
                                
                            

amount_usd (required) - Сумма, которую вы хотите получить в долларах США;
invoice_number - Ваш внутренний номер счета;
callback_link - Ваш уникальный URL-адрес, на который будет отправлен запрос о зачислении средств.

В ответ на запрос вы получаете JSON со следующим содержимым:

Example Response:

                                
{
    "status": true,
    "id": "8bef57df314eb6b98c7dbad5c14355d34a17f2439b777f2175cd0de484773c6f",
    "url": "https://biwse.com/general_invoice/8bef57df314eb6b98c7dbad5c14355d34a17f2439b777f2175cd0de484773c6f"
}                               
                            

Получение баланса приложения
Тип запроса:GET
URL:/api/v1/balance

Для получения баланса необходимо отправить запрос GET на этот адрес - https://biwse.com/api/v1/balance

Пример Запроса:

                                
curl -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
https://biwse.com/api/v1/balance
                            

В ответ на запрос вы получаете JSON со следующим содержимым:

Example Response:

                                
{
    "status": true,
    "total": 0.5,
    "confirmed": 0.5
}
                            

total – Общая сумма баланса;
confirmed - Подтвержденная сумма баланса.


Получение нового адреса
Тип запроса:GET
URL:/api/v1/new_address

Для получения адреса необходимо отправить запрос GET на этот адрес - https://biwse.com/api/v1/new_address

Пример Запроса

                                
curl -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
https://biwse.com/api/v1/new_address
                            

В ответ на запрос вы получаете JSON со следующим содержимым:

Example Response:


{
    "status": true,
    "address": "YOUR_NEW_ADDRESS"
}


Отправка денег
Тип запроса:POST
URL:/api/v1/send

Для того, чтобы отправить средства с вашего кошелька, вам необходимо отправить POST запрос на этот адрес - https://biwse.com/api/v1/send

Пример Запроса


curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"address": "ADDRESS",
"amount": 0.001
}' \
https://biwse.com/api/v1/send

Если транзакция прошла успешно, вы получите JSON в ответ на запрос следующего содержания:

Example Response:


{
    "status": true,
    "tx_hash": "TX_HASH"
}
                                

tx_hash – Хэш транзакции в сети;

Если вам нужно отправить несколько платежей в одной транзакции, вы должны отправить запрос POST на этот адрес - https://biwse.com/api/v1/multi_send

Пример Запроса


curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
        "payments":[
            {
                "address": "YOUR_ADDRESS_1",
                "amount": 0.001
            },
            {
                "address": "YOUR_ADDRESS_2",
                "amount": 0.001
            }
        ]
}' \
https://biwse.com/api/v1/multi_send

Максимальное количество разрешенных адресов для одной сделки-100.


Создание страницы накладной
Тип запросаPOST
URL:/api/v1/new_invoice

Счет - это страница квитанции об оплате.

У вас есть все необходимые данные для создания страницы счета, но если вы хотите использовать нашу страницу счета, вы должны отправить запрос POST на этот адрес - https://biwse.com/api/v1/new_invoice

В ответ на запрос вы получаете JSON со следующим содержимым:

Example Response:


{
    "status": true,
    "id": "HASH",
    "address": "ADDRESS",
    "url": "https://biwse.com/invoice/HASH"
}

url - это адрес платежной страницы ( страница доступна в течении 2 часов);
id - уникальный идентификатор платежа.

Счет доступен в течение 2 часов после его создания.

Пример Запроса


curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"amount": 0.001,
"callback_link": "https://yoursite.com"

}' \
https://biwse.com/api/v1/new_invoice

amount – Сумма платежа;
callback_link - Ваш уникальный URL-адрес, на который будет отправлен запрос о зачислении средств со следующим содержанием.

                                    
{
    "amount":  0.1,
    "confs": 1,
    "address": "ADDRESS",
    "tx_hash": "TX_HASH",
    "type": "BTC",
    "accepted": "1",
    "verification_hash": "md5(SECURITY_KEY+ADDRESS)"
}
                                

amount – Сумма платежа;
confs – Количество подтвержденных транзакций;
address – Адрес, по которому были получены средства;
tx_hash – Хэш транзакции в сети;
type – Тип криптовалюты;
accepted – Указывает, был ли счет полностью оплачен ("1" или "0");
verification_hash – Наш уникальный хэш для проверки подлинности запроса;
SECURITY_KEY – Это ключ безопасности вашего приложения. Не путайте его с Токеном.

Мы будем отправлять вам уведомления до тех пор, пока платеж не получит шесть подтверждений. Мы прекратим отправлять вам уведомления, если для другого запроса мы получим формат ответа JSON со следующим содержимым:


{
    "accepted": true
}

В таком случае, наша система будет считать, что ваш платеж принят.


Транзакции по адресу
Тип запросаGET
URL:/api/v1/get_transactions/{ADDRESS}

Чтобы получить все входящие транзакции по адресу необходимо послать GET запрос на этот адрес - https://biwse.com/api/v1/get_transactions/{ADDRESS}

Пример Запроса


curl -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
    https://biwse.com/api/v1/get_transactions/{ADDRESS}

В ответ на запрос вы получаете JSON со следующим содержимым:

Example Response:


{
    "status": true,
    "txs": [
        {
            "hash": "67062d8016469085b7fc31f24f6a6e3d378e86d8bec09e5baac4998bd2b5831d",
            "amount": "0.1459",
            "created_at": "2019-03-16 10:08:18"
        },
        {
            "hash": "8875e9e8007ce01e456b708b245136e93e6f382f4b075b8392d7574d67279923",
            "amount": "0.1459",
            "created_at": "2019-03-16 10:08:16"
        },
        {
            "hash": "2615a4a7c3a9dd4d1663037a82f27f66b8f603e85162fa0fba34d95a4814f1ab",
            "amount": "0.0459",
            "created_at": "2019-03-16 10:07:56"
        }
    ]
}

Get invoice status
Тип запросаGET
URL:/api/v1/get_invoice/{invoice_id}

To get information about the payment you need to send a GET request to this address - https://biwse.com/api/v1/get_invoice/{invoice_id}

Пример Запроса


curl -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
    https://biwse.com/api/v1/get_invoice/{INVOICE_ID}

В ответ на запрос вы получаете JSON со следующим содержимым:

Example Response:


{
    "status": true,
    "data": {
        "amount": 0.02,
        "confs": 4,
        "address": "mrnWggWKtK9wMFqc3yM4823ygc5Zr8g5Si",
        "tx_hash": "c69cb40b6947e24e78def49d979c97ab60fad98b29dd7bb94bbef3c561d9211d",
        "type": "BTC",
        "accepted": true,
        "verification_hash": "e014a9f36568a804d306c50cc5568e30"
    }
}