Docs

Rapido

Como Biwse é plataforma amigável desenvolvedor é fácil começar a criar coisas incríveis. Neste artigo você vai passar através do registro para a solução de trabalho e confiar em nós-é realy abaixo de 5 minutos

Tens de o fazer sign up for a Biwse account to get started.

Passo 1: API Token

Uma vez que você tem conta registrada você pode criar Aplicação. A aplicação é a sua carteira a que pode aceder através da nossa API. Você pode criar tantos appliacitons quanto você quiser alimentar projetos diferentes. O token da API é específico da aplicação, o que lhe permite gerenciar tokens através de seus projetos mais facilmente.

Você pode criar um novo token na página de Aplicação.

Note: Save token em um lugar seguro, que lhe permite acessar a API Biwse e gastar fundos.

Tip: Você pode realizar pedidos de API com token de teste test_token_I6Ims4a2dvNXJLUzMy e dar-lhe-á respostas com dados de teste.

Passo 2: Página da factura

Com o seu token de API, poderá gerar um novo endereço:

Pedido De Exemplo:

                                
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"}
                            

Use o endereço gerado para criar a página de fatura. Além disso, você precisa especificar a quantidade que você deseja receber:

Pedido De Exemplo:

                                

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..."}
                            

Você pode visitar link a partir de resposta e ver a sua página de fatura está pronto para funcionar!

E agora?
Cliente de PHP Biwse

A Biblioteca Biwse PHP fornece acesso à API Biwse.

Instalar o pacote com:


composer require biwse/biwse-php
                            

O pacote precisa ser configurado com o seu item de acesso à aplicação que está disponível no seu Biwse Dashboard

Configurar o cliente:


use Biwse\Client\Biwse;
// create API client using your token
$app = new Biwse("YOUR_TOKEN");
                            
Obter o equilíbrio

$res = $app->balance();
$total = $res->total;
$confirmed = $res->confirmed;
                            
Novo endereço

$res = $app->newAddress("https://your_cllback_link.com");
$address = $res->address;
                            
Enviar dinheiro

$res = $app->send("ADDRESS",0.001);
$txHash = $res->tx_hash;
                            
Multi enviar dinheiro

$res = $app->multiSend([ "payments" =>[
            ["address" => "ADDRESS_1","amount" => 0.001],
            ["address" => "ADDRESS_2","amount" => 0.001],
        ]
    ]);
$txHash = $res->tx_hash;
                            
Nova factura

$res = $app->newInvoice("YOUR_ADDRESS",0.1);
$invoiceUrl = $res->url;
                            
Cliente JS da Biwse

A Biblioteca Biwse JS fornece acesso à API Biwse.

Instalar o pacote com:


npm install biwse-js --save
                            

O pacote precisa ser configurado com o seu item de acesso à aplicação que está disponível no seu Biwse Dashboard

Configurar o cliente:


import BiwseAPI from 'biwse-js' 
// create API client using your token
const app = new BiwseAPI('your_token...')
                            
Novo endereço

Você pode omitir o argumento de callback (veja a referência da API)


const { address, status } = await app.newAddress('https://your_address...')
                            
Nova factura

const response = await app.newInvoice('btc_address...', 0.001)
const { status, id, url } = response
                            
Obter o equilíbrio

const response = await app.balance()
const { total, confirmed, status } = response
                            
Enviar dinheiro

const { tx_hash, status } = await app.send('btc_address...', 0.001)
                            
Multi enviar dinheiro

const { tx_hash, status } = await app.multiSend({payments: [
	{address: 'btc_address_1', amount: 0.001},
	{address: 'btc_address_2', amount: 0.001},
]})
                            
Como começar

Em primeiro lugar, você vai precisar de sua API-chave que nós fornecemos para carteiras. Você pode obter as chaves nas configurações de sua aplicação. Você tem que usar a API-key na interação com biwse.com. Todos os pedidos têm de conter estes cabeçalhos:

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

YOUR_TOKEN – a chave que recebeu na configuração da aplicação.


Factura Geral

Em primeiro lugar, você vai precisar de sua identificação de cliente que nós fornecemos para a página merchant. Você pode obter o ID do cliente nas configurações de sua página mercante.

Este método permite criar páginas de fatura onde os usuários podem escolher a moeda a usar para o pagamento.

Tipo de pedido:POST
URL:/general_invoice/CLIENT_ID

Para receber a página da fatura você tem que enviar um pedido por correio para este endereço - https://biwse.com/general_invoice/CLIENT_ID

Pedido De Exemplo

                                
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) - O montante que pretende obter em usd;
invoice_number - O seu número interno de factura;
callback_link - É o seu endereço URL único que irá receber um pedido de POST sobre a atribuição de fundos.

Em resposta ao pedido você recebe JSON com o seguinte conteúdo:

Example Response:

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

Obter um saldo de candidatura
Tipo de pedido:GET
URL:/api/v1/balance

Para receber o saldo você tem que enviar um pedido de GET para este endereço - https://biwse.com/api/v1/balance

Pedido De Exemplo:

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

Em resposta ao pedido você recebe JSON com o seguinte conteúdo:

Example Response:

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

total – Montante total do saldo;
confirmed - Montante do saldo confirmado.


A obter um novo endereço
Tipo de pedido:GET|POST
URL:/api/v1/new_address

Para receber o endereço você tem que enviar um pedido de GET para este endereço - https://biwse.com/api/v1/new_address

Pedido De Exemplo

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

Em resposta ao pedido você recebe JSON com o seguinte conteúdo:

Example Response:


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

Se você quiser receber notificações sobre creditar fundos para o endereço, em seguida, enviar um pedido de POST para este endereço https://biwse.com/api/v1/new_address

Pedido De Exemplo

                                
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"callback_link": "https://yoursite.com",
}' \
https://biwse.com/api/v1/new_address
                            

callback_link - é o seu endereço URL único que receberá um pedido de POST sobre a atribuição de fundos com o seguinte conteúdo.

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

amount – Pagamento;
confs – É o número de operações confirmadas;
address – Endereço para onde os fundos foram recebidos;
tx_hash – Barra de transacções na rede;
type – Tipo de moeda;
accepted – Indica se a factura foi integralmente paga ("1" or "0");
verification_hash – É o nosso hash exclusivo para verificar a autenticidade do pedido;
SECURITY_KEY – É a tua chave secreta de Aplicação. Não o confundas com Token..

Enviaremos notificações até o pagamento receber seis confirmações. Vamos parar de enviar notificações se para outro pedido nós recebemos um formato de resposta JSON com o seguinte conteúdo:


{
    "accepted": true
}

Neste caso, o nosso sistema considerará que o seu pagamento é aceite.


A enviar dinheiro
Tipo de pedido:POST
URL:/api/v1/send

Para enviar fundos de sua carteira, você tem que enviar um pedido de POST para este endereço - https://biwse.com/api/v1/send

Pedido De Exemplo


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

Se a transação for bem sucedida, você receberá JSON em resposta ao pedido com o seguinte conteúdo:

Example Response:


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

tx_hash – Barra de transacções na rede;

Se você precisa enviar vários pagamentos em uma transação você tem que enviar um pedido de POST para este endereço - https://biwse.com/api/v1/multi_send

Pedido De Exemplo


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

O número máximo de endereços permitidos para uma transacção é de 100.


Criar uma página de factura
Tipo de pedidoPOST
URL:/api/v1/new_invoice

Fatura é uma página de recibo de pagamento.

Você tem todos os dados necessários para criar a sua página de fatura, mas se você quiser usar a nossa página de fatura você tem que enviar um pedido de POST para este endereço - https://biwse.com/api/v1/new_invoice

Pedido De Exemplo


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

address - é o seu endereço onde deseja receber os pagamentos;
amount – Pagamento.

Em resposta ao pedido você recebe JSON com o seguinte conteúdo:

Example Response:


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

url - é um endereço de página de pagamento ( a página está disponível dentro de 2 horas);
id - é um identificador único de pagamento.

A fatura está disponível dentro de 2 horas após a sua criação.

Transactions at address
Tipo de pedidoGET
URL:/api/v1/get_transactions/{ADDRESS}

To receive all incoming transactions at the address you need to send a GET request to this address - https://biwse.com/api/v1/get_transactions/{ADDRESS}

Pedido De Exemplo


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}

Em resposta ao pedido você recebe JSON com o seguinte conteúdo:

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"
        }
    ]
}