bitgin-oauth2-client-example

command module

v0.0.0-...-6a1dff4 Latest Latest Go to latest Published: Feb 18, 2023 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bitgin/bitgin-oauth2-client-example

Links

Open Source Insights

README ¶

OAuth2

BITGIN's OAuth implementation supports the standard authorization code grant type

We also supply simple oauth2 client example to help you understand the authorization flow specifically and test easily.

Field	Description
client_id	represents your client id.
code_challenge	the value of code_verifier after sha256 hash.
user_id	optional, represents the id of user who want to login. if user_id is empty, user will have an additional step of login before authorizing
state	An unguessable random string. It is used to protect against cross-site request forgery attacks.

How to do code challenge ?

func main() {
    var codeVerifier = "sampleS256Code"

    codeChallenge := GetCodeChallenge(codeVerifier)
}

func GetCodeChallenge(codeVerifier string) string {
	s256 := sha256.Sum256([]byte(codeVerifier))
	return base64.URLEncoding.EncodeToString(s256[:])
}

Second, you need to have a GET hook api, that is to say, it’s your redirect_uri

You will receive the callback

Callback Params

Field	type	Description
code	string	the authentication code allow you to do exchange for token
state	string	An unguessable random string. It is used to protect against cross-site request forgery attacks.

Then, you can receive authorization code from redirect_uri, and use the code to exchange the access_token by call OAuth Server (https://oauth.bitgin.net) POST /v1/oauth/token

Header

Key	Value
Content-Type	x-www-form-urlencoded

Request Body

Field	type	Description
client_id	string	represents your client id.
client_secret	string	represents your client secret.
code_verifier	string	represents the plain text before doing sha256 hash to code_challenge
code	string	the authentication code allow you to do exchange for token
grant_type	string	represents the action you want to do, it would be authorization_code on here

Response Body

Field	type	Description
access_token	string	represents the token you can use to access resources of user, expired in 1 hour
token_type	string	represents access_token type (e.g. Bearer)
refresh_token	string	represents the token you can use to refresh access_token, expired in 90 days
expires_in	string	represents the time duration of access_token of seconds

Finally, You need to write response body

if you success to receive access token

Response Header

Key Value

Content-Type application/json

Response Body

Field Type Description

success boolean true
if you fail to receive access token

Response Header

Key Value

Content-Type application/json

Response Body

Field Type Description

success boolean false

message string, optional error message

How to refresh access token

OAuth Server (https://oauth.bitgin.net)

POST /v1/oauth/token

Header

Key	Value
Content-Type	x-www-form-urlencoded

Request Body

Field	type	Description
client_id	string	represents your client id.
client_secret	string	represents your client secret.
refresh_token	string	represents the token you can use to refresh access_token
grant_type	string	represents the action you want to do, it would be refresh_token on here

Response Body

Field	type	Description
access_token	string	represents the new token you can use to access resources of user
token_type	string	represents access_token type (e.g. Bearer)
refresh_token	string	represents the new token you can use to refresh access_token
expires_in	string	represents the time duration of access_token of seconds

Exchange API

Endpoint

OAuth Server (https://oauth.bitgin.net)

Request Header

Key	Value
Authorization	Bearer [Access Token]

Standard Response Format

Field	Type	Description
success	boolean
message	string	error message
data	json	response data
request_id	string	represents the request

Get Account

Query the information of account

Request

GET /v1/oauth/exchange/account

Response Format

{
    "success": true,
    "data": {
        "email": "usr****@domain.com",
        "phone": "+88627****776",
        "referral_code": "Qr11N6k2Mr",
        "kyc_level": 1,
        "kyc_status": "verified",
        "name": "王**明",
        "gender": "male",
        "birthday": 1506441600000,
        "id_type": "arc",
        "nationality": "US",
        "id_number": "553102****",
        "issuance_date": 1664776467170,
        "issuance_type": null,
        "issuance_location": null,
        "barcode_number": "123456****",
        "expiration_date": 1664867363326,
        "bank_code": "809",
        "branch_code": "0094",
        "account": "0060091694735777"
    }
}

Field	Type	Description
email	string	user's email
phone	string	user's phone
referral_code	string	user's referral code
kyc_level	number	user's kyc level
kyc_status	string	user's current kyc status, indicating lv1 status if `kyc_level` = 0 or lv2 status if `kyc_level` = 1
name	string	user's name
gender	string	gender
birthday	number	Unix time of current time, the number of milliseconds elapsed since January 1, 1970 UTC
id_type	string	id type
nationality	string	user's nationality, should follow ISO 3166-1 alpha-2
id_number	string	Taiwan ID number or ARC ID
issuance_date	number	Unix time of current time, the number of milliseconds elapsed since January 1, 1970 UTC
issuance_type	string	identity issue type, null if id type is `arc`
issuance_location	string	Taiwan identity card issuance location, null if id type is `arc`
barcode_number	string	barcode of ARC, null if id type is `id_card`
expiration_date	number	Unix time of current time, the number of milliseconds elapsed since January 1, 1970 UTC, null if id type is `id_card`
bank_code	string	user's submitted bank code
branch_code	string	user's submitted bank branch code
account	string	user's bank account

Get Account Bank

Query the information of bank of account

Request

GET /v1/oauth/exchange/account/bank

Response Format

{
    "success": true,
    "data": {
        "bank_code": "004",
        "bank_name": "臺灣銀行",
        "branch_code": "0071",
        "branch_name":"館前分行",
        "holder": "測先生",
        "number": "0060090100005333"
    }
}

Field	Type	Description
bank_code	string	represents code of bank
bank_name	string	represents name of bank
branch_code	string	represents code of branch
branch_name	string	represents name of branch
holder	string	represents the holder's name of bank account
number	string	represents the number of bank account

Get Account Fiat Deposit

Query the fiat deposit bank

Request

GET /v1/oauth/exchange/account/fiat_deposit

Response Format

{
    "success": true,
    "data": {
        "bank_code": "802",
        "bank_name": "凱基商業銀行",
        "branch_code": "0072",
        "branch_name":"城東分行",
        "holder": "凱基商業銀行受託信託財產專戶",
        "number": "51730000007724"
    }
}

Field	Type	Description
bank_code	string	represents code of bank
bank_name	string	represents name of bank
branch_code	string	represents code of branch
branch_name	string	represents name of branch
holder	string	represents the holder's name of bank account
number	string	represents the number of virtual account

Get Balance

Query balances of account

Request

GET /v1/oauth/exchange/wallet/balances?currency={currency}

Parameters

Field	Type	Description
currency	string	optional, if the field is empty, it will return all balances information as default. (e.g. BTC, ETH, USDT, TWD)

Response Format

{
    "success": true,
    "data": [
        {
            "currency": "USDT",
            "total": "45.4",
            "available": "45.4",
            "locked": "0"
        }
    ]
}

Field	Type	Description
currency	string	BTC, ETH, USDT, TWD
total	decimal	total amount
available	decimal	amount available
locked	decimal	amount locked

Get Deposit History

Query deposit history

Request

GET /v1/oauth/exchange/wallet/deposit?id={id}&currency={currency}&start_time={start_time}&end_time={end_time}&limit={limit}&offset={offset}

Parameters

Field	Type	Description
id	string	represents deposit id
currency	string	represents deposit currency (e.g. BTC, ETH, USDT, TWD)
start_time	number	Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
end_time	number	Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
limit	number	represents limit of pagination
offset	number	represents offset of pagination

Response Format

{
    "success": true,
    "data": [
        {
            "id": "c82b7de8-c654-4d9e-b84e-022b52c189bb",
            "status": "completed",
            "currency": "USDT",
            "chain": "Tron",
            "amount": "1500",
            "txid": "ba2f799dd1607a0d118dd9320019ea9ca7e42492760e76abbeb27b29f6404cf7",
            "created_at": 1615974333,
            "updated_at": 1615974333,
            "completed_at": 1615975346
        },
        {
            "id": "c82b7de8-c654-4d9e-b84e-022b52c189bb",
            "status": "completed",
            "currency": "TWD",
            "chain": null,
            "amount": "750",
            "created_at": 1615974333,
            "updated_at": 1615974333,
            "completed_at": 1615975346
        }
    ]
}

Field	Type	Description
id	string	represents deposit id
status	string	status of deposit
currency	string	BTC, ETH, USDT, TWD
chain	string	Bitcoin, Ethereum, Tron
amount	decimal	total amount
txid	string	transaction hash
created_at	number	when the deposit was created, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
updated_at	number	when the deposit was updated, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
completed_at	number	only exists when the deposit was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Get Deposit Address

Query deposit addresses of account

Request

GET /v1/oauth/exchange/wallet/deposit_address?currency={currency}

Parameters

Field	Type	Description
currency	string	BTC, ETH, USDT

Response Format

{
    "success": true,
    "data": [
        {
            "chain": "Tron",
            "address": "TXHzvoDBPaG7YbSgb3zdoosJK4x4Kmf2J2"
        },
        {
            "chain": "Ethereum",
            "address": "0xB76204882Fbef161428588560b48dB570A9d42Bb"
        }
    ]
}

Field	Type	Description
chain	string	Bitcoin, Ethereum, Tron
address	string

Get Withdrawal History

Query withdrawal history

Request

GET /v1/oauth/exchange/wallet/withdrawal?id={id}&currency={currency}&start_time={start_time}&end_time={end_time}&limit={limit}&offset={offset}

Parameters

Field	Type	Description
id	string	represents withdrawal id
currency	string	represents withdrawal currency (e.g. BTC, ETH, USDT, TWD)
start_time	number	Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
end_time	number	Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
limit	number	represents limit of pagination
offset	number	represents offset of pagination

Response Format

{
    "success": true,
    "data": [
        {
            "id": "c82b7de8-c654-4d9e-b84e-022b52c189bb",
            "status": "completed",
            "currency": "USDT",
            "chain": "Tron",
            "amount": "1500",
            "fee": "0",
            "fee_currency": "USDT",
            "to_address": "TXHzvoDBPaG7YbSgb3zdoosJK4x4Kmf2J2",
            "txid": "ba2f799dd1607a0d118dd9320019ea9ca7e42492760e76abbeb27b29f6404cf7",
            "created_at": 1615974333,
            "updated_at": 1615974333,
            "completed_at": 1615975346
        },
        {
            "id": "c82b7de8-c654-4d9e-b84e-022b52c189bb",
            "status": "pending",
            "currency": "USDT",
            "chain": "Tron",
            "amount": "200",
            "fee": "0",
            "fee_currency": "USDT",
            "to_address": "TXHzvoDBPaG7YbSgb3zdoosJK4x4Kmf2J2",
            "created_at": 1615974333,
            "updated_at": 1615974333
        }
    ]
}

Field	Type	Description
id	string	represents withdrawal id
status	string	status of withdrawal
currency	string	BTC, ETH, USDT, TWD
chain	string	Bitcoin, Ethereum, Tron
amount	decimal	total amount
fee	decimal
fee_currency	string	BTC, ETH, USDT, TWD
to_address	string
txid	string	transaction hash
created_at	number	when the withdrawal was created, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
updated_at	number	when the withdrawal was updated, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
completed_at	number	only exists when the withdrawal was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Request Withdrawal

Send the request of withdrawal

Request

POST /v1/oauth/exchange/wallet/withdrawal

Header

Key	Value
Content-Type	application/json

Post Body

{
    "chain": "Tron",
    "currency": "USDT",
    "address": "",
	"amount": "100",
	"is_deduction": true
}

Field	Type	Description
chain	string	Bitcoin, Ethereum, Tron
currency	string	BTC, ETH, USDT, TWD
address	string	withdrawal address
amount	decimal	withdrawal amount
is_deduction	boolean

Response Format

{
    "success": true,
    "data": {
        "id": "901c6edc-0c2e-4f5a-857d-c7ffb4efcaa0",
        "user_id": "351c0599-17b9-44ad-b10e-29f93b52863e",
        "created_at": 1668436093256,
        "updated_at": 1668436093288,
        "status": "pending",
        "completed_at": null,
        "type": "crypto",
        "amount": "100",
        "fee": "0.5",
        "currency": "USDT",
        "fee_currency": "USDT",
        "chain": "Tron",
        "to_address": "TSNpBZhQsGdVoGYB3yhzFA8wimzMtuG2s9"
    }
}

Field	Type	Description
id	string	represents withdrawal id
user_id	string	represents user id
status	string	status of withdrawal
type	string	type of withdrawal
currency	string	BTC, ETH, USDT, TWD
chain	string	Bitcoin, Ethereum, Tron
amount	decimal	total amount
fee	decimal
fee_currency	string	BTC, ETH, USDT, TWD
to_address	string
created_at	number	when the withdrawal was created, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
updated_at	number	when the withdrawal was updated, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
completed_at	number	when the withdrawal was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Confirm Withdrawal

Confirm the withdrawal with OTP code

Request POST /v1/oauth/exchange/wallet/withdrawal/confirm

Header

Key	Value
Content-Type	application/json

Post Body

{
    "id": "c82b7de8-c654-4d9e-b84e-022b52c189bb",
    "code": "123456"
}

Field	Type	Description
id	string	represents withdrawal id
code	string	phone OTP code for verification

Response Format

{
    "success": true,
    "data": {
        "id": "901c6edc-0c2e-4f5a-857d-c7ffb4efcaa0",
        "user_id": "351c0599-17b9-44ad-b10e-29f93b52863e",
        "created_at": 1668436093256,
        "updated_at": 1668436117019,
        "status": "sent",
        "completed_at": null,
        "type": "crypto",
        "amount": "100",
        "fee": "0.5",
        "currency": "USDT",
        "fee_currency": "USDT",
        "chain": "Tron",
        "to_address": "TSNpBZhQsGdVoGYB3yhzFA8wimzMtuG2s9"
    }
}

Field	Type	Description
id	string	represents withdrawal id
user_id	string	represents user id
status	string	status of withdrawal
type	string	type of withdrawal
currency	string	BTC, ETH, USDT, TWD
chain	string	Bitcoin, Ethereum, Tron
amount	decimal	total amount
fee	decimal
fee_currency	string	BTC, ETH, USDT, TWD
to_address	string
created_at	number	when the withdrawal was created, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
updated_at	number	when the withdrawal was updated, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
completed_at	number	when the withdrawal was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Request Fiat Withdrawal

Send the request of fiat withdrawal

Request

POST /v1/oauth/exchange/wallet/withdrawal/fiat

Header

Key	Value
Content-Type	application/json

Post Body

{
	"amount": "100",
}

Field	Type	Description
amount	decimal	withdrawal TWD amount

Response Format

{
    "success": true,
    "data": {
        "id": "be0278f0-5516-41ff-b25e-63353a0763d1",
        "user_id": "351c0599-17b9-44ad-b10e-29f93b52863e",
        "created_at": 1668489917031,
        "updated_at": 1668489917076,
        "status": "waiting_approval",
        "completed_at": null,
        "type": "fiat_kgi",
        "amount": "100",
        "fee": "0",
        "currency": "TWD",
        "fee_currency": "TWD"
    }
}

Field	Type	Description
id	string	represents withdrawal id
user_id	string	represents user id
status	string	status of withdrawal
type	string	type of withdrawal
currency	string	BTC, ETH, USDT, TWD
amount	decimal	total amount
fee	decimal
fee_currency	string	BTC, ETH, USDT, TWD
created_at	number	when the withdrawal was created, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
updated_at	number	when the withdrawal was updated, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
completed_at	number	when the withdrawal was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Get Trade History

Query trade history

Request

GET /v1/oauth/exchange/trade?id={id}&market={market}&start_time={start_time}&end_time={end_time}&limit={limit}&offset={offset}

Parameters

Field	Type	Description
id	string	represents trade id
market	string	represents trade market (e.g. BTCTWD, ETHTWD, USDTTWD)
start_time	number	Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
end_time	number	Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
limit	number	represents limit of pagination
offset	number	represents offset of pagination

Response Format

{
    "success": true,
    "data": [
        {
            "id": "b3422e63-9112-499e-be60-1997f9455f6b",
            "market": "USDTTWD",
            "side": "buy",
            "price": "29.03",
            "size": "1000",
            "fee": "0",
            "fee_rate": "0",
            "fee_currency": "USDT",
            "time": 1615975346
        }
    ]
}

Field	Type	Description
id	string	trade id
market	string	trading pair
side	string	order side (e.g. buy, sell)
price	decimal	price of the transaction
size	decimal	total amount of the transaction
fee	decimal	fee per transaction
fee_rate	decimal
fee_currency	string	Bitcoin, Ethereum, Tron, TWD
time	number	when the transaction was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Get Quote

Get quote of trade

Request

POST /v1/oauth/exchange/trade/quote

Header

Key	Value
Content-Type	application/json

Post Body

{
    "market": "USDTTWD",
    "side": "buy",
    "base_amount": "1000",
}

Field	Type	Description
market	string	trading pair
side	string	order side (e.g. buy, sell)
base_amount	decimal	total amount you want to buy/sell (e.g. USDT, ETH, BTC)
quote_amount	decimal	total amount you want to buy/sell (e.g. TWD)

Response Format

{
    "success": true,
    "data": {
        "id": "ad122e63-9112-499e-be60-1997f9455f6b",
        "market": "USDTTWD",
        "side": "buy",
        "price": "29.03",
        "base_amount": "1000",
        "quote_amount": "29030",
        "fee": "0",
        "fee_rate": "0",
        "fee_currency": "USDT",
        "created_at": 1615974333,
        "expired_at": 1615974333
    }
}

Field	Type	Description
id	string	quotation id
market	string	trading pair
side	string	order side (e.g. buy, sell)
price	decimal	current price
base_amount	decimal	total amount you want to buy/sell (e.g. USDT, ETH, BTC)
quote_amount	decimal	total amount you want to buy/sell (e.g. TWD)
fee	decimal	fee per transaction
fee_rate	decimal
fee_currency	string	Bitcoin, Ethereum, Tron, TWD
created_at	number	when the quotation was created, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC
expired_at	number	when the quotation expires, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Accept Quote

Accept quote of trade

Request

POST /v1/oauth/exchange/trade/quote/accept

Header

Key	Value
Content-Type	application/json

Post Body

{
    "id": "ad122e63-9112-499e-be60-1997f9455f6b"
}

Field	Type	Description
id	string	quote id

Response Format

{
    "success": true,
    "data": [
        {
            "id": "b3422e63-9112-499e-be60-1997f9455f6b",
            "market": "USDTTWD",
            "side": "buy",
            "price": "29.03",
            "size": "1000",
            "fee": "0",
            "fee_rate": "0",
            "fee_currency": "USDT",
            "time": 1615975346
        }
    ]
}

Field	Type	Description
id	string	trade id
market	string	trading pair
side	string	order side (e.g. buy, sell)
price	decimal	price of the transaction
size	decimal	total amount of the transaction
fee	decimal	fee per transaction
fee_rate	decimal
fee_currency	string	Bitcoin, Ethereum, Tron, TWD
time	number	when the transaction was completed, Unix time of current time, the number of `milliseconds` elapsed since January 1, 1970 UTC

Withdrawal Type Definition

Value	Description
crypto	crypto withdrawal
fiat_kgi	fiat withdrawal
internal_transfer	internal transfer (e.g. from BITGIN address to BITGIN address)

Withdrawal Status Definition

Value	Description
pending	withdrawal is waiting to be sent
waiting_approval	withdrawal is waiting for an approval
approved	withdrawal approved
bank_verifying	withdrawal is in bank procedure
sent	withdrawal sent
completed	withdrawal completed
cancelled	withdrawal has been cancelled
rejected	withdrawal has been rejected
failed	withdrawal failed

Deposit Status Definition

Value	Description
waiting_confirmation	deposit confirmation count on the blockchain
completed	deposit completed
rejected	deposit has been rejected

Order Side Definition

Value	Description
buy	order side buy
sell	order side sell

Market Definition

Value	Description
USDTTWD	base: USDT, quote TWD
ETHTWD	base: ETH, quote TWD
BTCTWD	base: BTC, quote TWD

Gender Category

Value	Description
male
female

ID Type

Value	Description
id_card	Taiwan Identity Card
arc	ARC

KYC Level

Value	Description
0	no kyc passed
1	kyc lv1 passed
2	kyc lv2 passed

KYC Status

Value	Description
not_submitted	kyc is not submitted
verifying	kyc is verifying
verified	kyc is verified
rejected	kyc is rejected

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

bitgin-oauth2-client-example

README ¶

OAuth2

Table of contents

Quick Start

Authentication

How to get access token

How to refresh access token

Exchange API

Get Account

Get Account Bank

Get Account Fiat Deposit

Get Balance

Get Deposit History

Get Deposit Address

Get Withdrawal History

Request Withdrawal

Confirm Withdrawal

Request Fiat Withdrawal

Get Trade History

Get Quote

Accept Quote

Withdrawal Type Definition

Withdrawal Status Definition

Deposit Status Definition

Order Side Definition

Market Definition

Gender Category

ID Type

KYC Level

KYC Status

Documentation ¶

Source Files ¶