Skip to content

Fix HMAC auth docs (Base64, Pro URL, URL-safe secrets) #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
guiviaje wants to merge 1 commit into from
Closed

Fix HMAC auth docs (Base64, Pro URL, URL-safe secrets) #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions anboto-trading-api-2.0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
---
openapi: 3.0.1
info:
title: Anboto Trading API
description: "Anboto Trading API <BR><BR> <B>Authentication</B><BR>Please visit\
\ Anboto's website to generate an API key<BR> Mainnet:<BR> - <a href=\"\
https://api.trade.anboto.xyz\">https://api.trade.anboto.xyz</a><BR> Testnet:<BR>\
https://api.trade.anboto.xyz\">https://api.trade.anboto.xyz</a><BR> Pro:<BR> - <a href=\"\
https://api.pro.anboto.xyz\">https://api.pro.anboto.xyz</a> (<a href=\"https://pro.anboto.xyz/settings/api\"\
>Settings API</a>)<BR> Testnet:<BR>\
\ - <a href=\"https://api.testnet.anboto.xyz\">https://api.testnet.anboto.xyz</a><BR>\
\ <I>(All trades are simulated on testnet and will not trade on any real\
\ exchange)</I><BR><BR>Select Your API Key Type<BR> 1) <B>System-generated</B>\
Expand All @@ -22,10 +25,12 @@ info:
\ steps:</B><BR>1. The string to sign should be a concatenation of 'timestamp\
\ + API key + (recv_window) + (queryString | jsonBodyString)' The queryString\
\ should be assembled in alphabetical order.<BR>2. Take your secret key and decode\
\ from Base664 into a byte array and then use the HMAC_SHA256 (for system generated\
\ keys) or RSA_SHA256 algorithm to sign the string in step 1.<BR>3. Convert the\
\ signed value to a hex string (HMAC_SHA256) / base64 (RSA_SHA256) to obtain the\
\ sign parameter.<BR>4. Append the sign parameter to request header, and send\
\ from Base64 into a byte array (standard Base64 if the secret contains +, /, or\
\ ends with =; otherwise URL-safe Base64 with padding). Then use HMAC_SHA256\
\ (for system generated keys) or RSA_SHA256 algorithm to sign the string in step\
\ 1.<BR>3. For HMAC keys, set X-SIGN to standard Base64 of the digest (not hex).\
\ For RSA keys, use Base64 of the signature.<BR>4. Append the sign parameter to\
\ request header, and send\
\ the HTTP request. <BR><BR>Examples can be found here: <a href=\"https://github.com/anbotolabs/examples\"\
>https://github.com/anbotolabs/examples</a><BR>The OpenAPI spec can be found here:\
\ <a href=\"https://anbotolabs.github.io/anboto-api-docs/anboto-trading-api-2.0.yml\"\
Expand Down