Introdução WebSocket¶
No exemplo descrito nesta documentação, utilizamos NodeJs e a biblioteca ws.
Instale a últimaversão estável do NodeJs em: https://nodejs.org/en/download/
Abra Terminal (Mac), Cmd (Windows) ou Bash (Linux) e entre com o comando:
Na mesma pasta que você ira salvar os scripts exemplificados abaixo
npm install ws
ref link: https://www.npmjs.com/package/ws
GitHub - Exemplo WebSocket¶
- Você pode fazer o download do exemplo diretamente do repositório no GitHub:
Conectando Websocket¶
Uso em NodeJs.:
//Instantiate Websocket module
const WebSocket = require('ws');
//WebSocketAPI Address
var wsAddress = 'wss://api.foxbitapi.com.br/WSGateway/';
//Setup WebSocket client Address
var ws = new WebSocket(wsAddress);
Message Frame¶
Objeto em formato JSON-formatted utilizado como frame para enviar e receber dados.:
//Message Frame
var messageFrame = {
"m":0, //MessageType ( 0_Request / 1_Reply / 2_Subscribe / 3_Event / 4_Unsubscribe / Error )
"i":0, //Sequence Number
"n":"", //Endpoint
"o":"" //Payload
};
| String | Value |
|---|---|
| “m” message type | integer (0 request / 1 reply / 2 subscribe to event / 3 event / 4 unsubscribe from event / 5 error) |
| “i” sequence number | long integer |
| “n” function name | integer |
| “o” payload | string |
Payload¶
Objeto em formato JSON-formatted qual contém campos obrigatórios (e diferentes) para o envio de dados o endpoint acionado.
Cada endpoint tem um pacote específico, consulte o formato do payload na documentação.
//Exemplo de construção do payload para o endpoint *WebAuthenticateUser* var payload = { "UserName": "[email protected]", "Password": "jsPassword" };
Eventos¶
Defina o evento Open para tratar o retorno da conexão.:
//Event Open Connection ws.on('open', function open() { console.log('Conected'); });Defina evento para receber a mensagem do socket.:
//Event Receiving Message ws.on('message', function incoming(data) { //data contém o payload de resposta console.log(data); });Defina evento para tratamento de erros.:
//Event Error Message ws.on('error', function() { console.log('Error'); });Defina evento tratar a finalização da conexão.:
//Event Close Message ws.on('close', function() { console.log('Connection Closed'); });
Enviando Dados¶
Para enviar dados ao servidor você deve utilizar o objeto “messageFrame” descrito acima, utilize o campo “n” para informar o Endpoint a acionar e o campo “o” para envio do payload.
//Indique para qual endpoint será enviado. messageFrame.n = "WebAuthenticateUser" //Adicione o payload referente ao endpoint indicado messageFrame.o = JSON.stringify(payload); ws.send(JSON.stringify(messageFrame), function ack(error) { //Se encontrar erros, dispara console.log(error); });Dados enviados, caso não retorne erro finaliza a mensagem no evento mensagem.
Autenticação¶
Abaixo seguem os endpoints para autenticação de usuário no websocket
WebAuthenticateUser¶
WebAuthenticateUser autentica um usuário no WebSession corrente.
Você precisa chama-lo para utilizar os métodos que requerem um SessionToken ativo.
Ao realizar a autenticação, um SessionToken é informado. Guarde-o em uma variável.
Request:
{ "UserName": "UserName", "Password": "Password" } >>> Nota: UserName é o e-mail do usuárioSem sucesso na autenticação:
{ "Authenticated": false }Resposta quando o usuário já está logado:
{ "Authenticated": true, "SessionToken":"7d0ccf3a-ae63-44f5-a409-2301d80228bc", "UserId": 1 } >>> Nota: Voce deve guardar o SessionToken em uma variável.Resposta entregando um SessionToken ativo
String Value Authenticated Boolean. SessionToken string. UserId integer.
AuthenticateUser¶
AuthenticateUser autentica um usuário no WebSession corrente utilizando APIKEY definido previamente
Você precisa chama-lo para utilizar os métodos que requerem um SessionToken ativo.
AuthenticateUser pode ser chamado sempre que for necessária uma autenticação.
Request:
{ "APIKey": "APIKey", "Signature": "Signature" "UserId": "UserId", "Nonce": "Nonce" } >>> Nota 1: Nonce = Date.now(); >>> Nota 2: Signature = crypto.HmacSHA256(nonce + userId + APIKey, APISecret).toString(crypto.enc.Hex);Sem sucesso na autenticação:
{ "Authenticated": false }
String Value Authenticated Boolean. SessionToken string. UserId integer.
Authenticate2FA¶
Completa a segunda parte da autenticação em dois passos, segue abaixo os passos da autenticação 2FA.
Request:
{ "Code": "YourCode" }
String Value Code string. Insira o código 2FA Response:
{ "Authenticated": true, "SessionToken": "YourSessionToken" }O SessionToken é válido durante sessão corrente paraq o mesmo IP (IPAddress).
A sessão dura até 1 hora após a última atividade ou até ser executado endpoint LogOut.
Se a conexão for interrompida você pode reativa-la utilizando o SessionToken e chamando novament o Endpoint Authenticate2FA sem a necessidade de logar novamente ou informar o 2FA Key.
{ "SessionToken": "YourSessionToken" }
String Value Authenticated Boolean. Autenticação com sucesso retorna True. Sem sucesso retorna False SessionToken string. O SessionToken é válido para sessão atual para conexões com o mesmo endereço IP. Se a comunicação for interrompida você pode informar retornando o SessionToken ao invés de repetir o processo 2FA completo. Uma sessão dura até 1 hora de inatividade, ou até ser executado o LogOut.
Para enviar o SessionToken para restabelecer a conexão envie:
{
"SessionToken": "YourSessionToken"
}
Exemplo Websocket Completo¶
Abaixo você pode visualizar exemplo completo da aplicação em Nodejs consumindo Websocket da Foxbit.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 | //Instantiate Websocket module
const WebSocket = require('ws');
//WebSocketAPI Address
var wsAddress = 'wss://api.foxbitapi.com.br/WSGateway/';
//Instantiate SleepModule
var sleep = require('system-sleep');
//Setup WebSocket client Address
var ws = new WebSocket(wsAddress);
//Flag Authenticated
var authenticated = false;
//User & Password
var userLogin = "";
var userPass = "";
var userId = "0";
var sessionToken = "";
//Wait PromptInformation
var stdin2FA = process.openStdin();
//side variable = Buy/Sell
var side = 1;
//Message Frame
var messageFrame = {
"m":0, //MessageType ( 0_Request / 1_Reply / 2_Subscribe / 3_Event / 4_Unsubscribe / Error )
"i":0, //Sequence Number
"n":"", //Function Name
"o":"" //Payload
};
//WebSocket Event Area
//Event Open Connection
ws.on('open', function open() {
consoleMessage('------------------------------------------------------------------------','startup');
consoleMessage('Got connection','open.event');
//Start first command
WebAuthenticateUser(messageFrame);
consoleMessage('End connection','open.event');
});
//Event Receiving Message
ws.on('message', function incoming(data) {
dealMessage(messageFrame, data);
});
//Event Error Message
ws.on('error', function() {
consoleMessage('WebService','error! ');
});
//Event Close Message
ws.on('close', function() {
consoleMessage('WebService','close! ');
WebAuthenticateUser(frame);
});
/*
//Event End Message
ws.on('end', function(data) {
consoleMessage('WebService','end! ' + data);
});
*/
//Function AskUserInfo
function AskPrompt(message){
consoleMessage(message);
stdin.addListener("data", function(d) {
var ret = d.toString().trim();
consoleMessage('!AskPrompt', ret);
return ret;
});
}
//Function DealMessage
function dealMessage(frame, message){
var ret = JSON.parse(message);
if (ret.n == "WebAuthenticateUser"){
consoleMessage('<-' + ret.n, JSON.stringify(ret));
if (authenticated == false){
Authenticate2FA(frame);
}
}else if (ret.n == "GetUserInfo"){
consoleMessage('<-' + ret.n, JSON.stringify(ret));
}else if (ret.n == 'SendOrder'){
consoleMessage('<-' + ret.n, JSON.stringify(ret));
}else if(ret.n == 'Authenticate2FA') {
authenticated = true;
consoleMessage('<-' + ret.n, JSON.stringify(ret));
var paramO;
if (ret.o != undefined){
paramO = JSON.parse(ret.o);
sessionToken = JSON.stringify(paramO.SessionToken);
userId = JSON.stringify(paramO.UserId);
consoleMessage('<- sessionToken', sessionToken);
consoleMessage('<- userId', userId);
Authenticate2FA(frame);
}
}else{
consoleMessage('<-' + ret.n, JSON.stringify(ret));
}
}
//Startup Function
function startTrading(frame){
SendOrder(frame);
}
//Function WebAuthenticateUser
function WebAuthenticateUser(frame){
frame.n = "WebAuthenticateUser";
var requestPayload = {"UserName": userLogin, "Password": userPass};
frame.o = JSON.stringify(requestPayload);
consoleMessage(frame.n, JSON.stringify(frame));
ws.send(JSON.stringify(frame), function ack(error) {
if (error != undefined){
consoleMessage('Error', JSON.stringify(error));
}
});
}
//Function Authenticate2FA
function Authenticate2FA(frame){
frame.n = "Authenticate2FA";
var twoFA = "0000";
if (sessionToken == ""){
consoleMessage(frame.n, 'Enter with 2FA Code:');
stdin2FA.addListener("data", function(d) {
twoFA = d.toString().trim();
if (twoFA != "0000"){
var requestPayload = { "Code": twoFA };
frame.o = JSON.stringify(requestPayload);
consoleMessage(frame.n, JSON.stringify(frame));
ws.send(JSON.stringify(frame), function ack(error) {
if (error != undefined){
console.log('<- Authenticate2FA.error: (' + error + ')');
}
});
}
});
}else{
consoleMessage('Already logged! SessionToken + UserId', sessionToken + ' + ' + userId);
frame.n = "WebAuthenticateUser";
var requestPayload = { "UserId": userId , "SessionToken": JSON.parse(sessionToken) };
frame.o = JSON.stringify(requestPayload);
consoleMessage(frame.n, JSON.stringify(frame));
ws.send(JSON.stringify(frame), function ack(error) {
if (error != undefined){
console.log('<- Authenticate2FA.error: (' + error + ')');
}
});
GetUserInfo(frame);
}
}
//Function SendOrder
function SendOrder(frame){
frame.n = "SendOrder";
var requestPayload = {
"AccountId": 84437,
"ClientOrderId": 0,
"Quantity": 0.00001,
"DisplayQuantity": 0,
"UseDisplayQuantity": true,
"LimitPrice": 0,
"OrderIdOCO": 0,
"OrderType": 1, //ORDEM A MERCADO = 1
"PegPriceType": 1,
"InstrumentId": 1,
"TrailingAmount": 1.0,
"LimitOffset": 2.0,
"Side": side,
"StopPrice": 0,
"TimeInForce": 1,
"OMSId": 1,
};
frame.o = JSON.stringify(requestPayload);
if (side == 0){
side = 1;
}else{
side = 0;
}
console.log('\r\n-> ' + JSON.stringify(frame));
ws.send(JSON.stringify(frame), function ack(error) {
ws = new WebSocket('wss://api.foxbitapi.com.br/WSGateway/')
console.log('SendOrder.error: (' + error + ')');
});
}
function CancelOrder(frame, OrderId){
frame.n = "CancelOrder";
requestPayload2 = {
"OMSId": 1,
"AccountId":81
};
frame.o = JSON.stringify(requestPayload2);
ws.send(JSON.stringify(frame), function ack(error) {
console.log('CancelOrder.error: (' + error + ')');
});
}
function GetOrderHistory(frame){
frame.n = "GetOrderHistory";
requestPayload2 = {
"OMSId": 1,
"AccountId":81
};
frame.o = JSON.stringify(requestPayload2);
ws.send(JSON.stringify(frame), function ack(error) {
console.log('GetOrderHistory.error: (' + error + ')');
});
}
function GetOpenOrders(frame){
frame.n = "GetOpenOrders";
requestPayload2 = {
"AccountId":81,
"OMSId": 1
};
frame.o = JSON.stringify(requestPayload2);
ws.send(JSON.stringify(frame), function ack(error) {
console.log('GetOpenOrders.error: (' + error + ')');
});
}
function GetUserInfo(frame){
frame.n = "GetUserInfo";
requestPayload2 = {
};
frame.o = JSON.stringify(requestPayload2);
ws.send(JSON.stringify(frame), function ack(error) {
console.log('GetUserInfo.error: (' + error + ')');
});
}
function GetUserConfig(frame){
frame.n = "GetUserConfig";
requestPayload2 = {
};
frame.o = JSON.stringify(requestPayload2);
ws.send(JSON.stringify(frame), function ack(error) {
console.log('GetUserInfo.error: (' + error + ')');
});
}
//Function Console
function consoleMessage(prefix, sulfix){
console.log('\r\n' + prefix + ': (' +sulfix + ')\r\n');
}
|