Are there any Documentation Tools for JSON RPC API's?
I found a lot which are perfect for RESTful API's (Slate, Spotlight, Swagger) but sadly none suitable for JSON RPC API's.
Ideal would be a Tool that can handle both.
Are there any?
Thanks a lot!
Found a couple:
https://github.com/mzernetsch/jrgen
https://github.com/contributte/anabelle
Looking at using jrgen for my project.
Check this one: https://jsight.io
JSight has HTTP REST and also JSON-RPC 2.0 support, look here for details: https://jsight.io/docs/jsight-api-0-3-quick-tutorial
This is the JSON-RPC definition example from the site:
JSIGHT 0.3
URL /api/rpc
Protocol json-rpc-2.0
Method createCat // Create a cat.
Params
{
"cat": #cat
}
Result
{
"id": 1 // Cat’s id.
}
Method getCat // // Get a cat by its id.
Params
{
"id": 1 // Cat’s id.
}
Result
#cat
TYPE #cat
{
"id": 1,
"name": "Tom"
}
The same example in the cloud: https://editor.jsight.io/r/qjxRR6a/1
Related
I have use Technical Profile in B2C custom policy to call REST API and it returned format like this
{
"value": [
{
"id":"00000000000"
"name": "",
}
]
}
So in case how to get id and map it to output claim ? Please let me know a way to do it, I have investigated but I can not find out a solution so far
Did you try this?
https://learn.microsoft.com/en-us/azure/active-directory-b2c/json-transformations#getclaimfromjson
You want to extract value.0.id
Here you can see example json:
https://github.com/azure-ad-b2c/unit-tests/blob/main/claims-transformation/json/CT_GetClaimFromJson.xml
Assume I have a function in the backend server like this:
function get_bot_id(bot_name) { ... }
[A] I design a payload for a POST REST-API request like this:
{
"get_bot_id": "my_beautyful_bot"
}
[B] My co-workers claim that this payload below has more security.
{
"action": "get_bot_id",
"value": "my_beautyful_bot"
}
However, as for security claims, I don't see that [B] is better than [A].
I believe we just make the payload unnecessarily and larger without other benefits.
Does anyone have any opinions? Thank you!
The question is about kucoin websocket public channel (not trades) just last trades
I just want a live feed of trades like other crypto exchanges...
but when I want to connect to "wss://ws-api-futures.kucoin.com/endpoint" I get WebSocketError: Received unexpected status code (401 Unauthorized)
the documentation https://docs.kucoin.com/futures/#create-connection lack explications :(
normally with other exchanges I can just do this in javascript
bybit_market_ws = new WebSocket("wss://stream.bybit.com/spot/quote/ws/v2");
bybit_market_ws.onmessage = event => bybit_trades(event.data);
bybit_market_ws.onopen = event => bybit_market_ws.send(JSON.stringify({"topic":"trade","params":{"symbol":"BTCUSDT","binary":false},"event":"sub"}));
function bybit_trades (jsonx) { console.log(JSON.parse(jsonx)); }
so how can I do that with kucoin websocket ?
according to the documentation i would need a "public token"...
but there is no explication on how to get that token :(
does someone knows how I would retrieve the last trades via websocket (public) channel ?
Note that the following steps may be changed when the API is updated.
All information can be found at https://docs.kucoin.com/#apply-connect-token
Get the public token
Send a empty http POST (GET will not work) message to https://api.kucoin.com/api/v1/bullet-public.
Response:
{
"code": "200000",
"data": {
"token": "2neAiuYvAU61ZD...",
"instanceServers": [
{
"endpoint": "wss://ws-api.kucoin.com/endpoint",
"encrypt": true,
"protocol": "websocket",
"pingInterval": 18000,
"pingTimeout": 10000
}
]
}
}
Connect to the Websocket
With the data of the repsonse above:
websocket: endpoint + "?token=" + token
Example: wss://ws-api.kucoin.com/endpoint?token=2neAiu....
Get all supported trading pairs
send a http GET message to https://api.kucoin.com/api/v1/symbols
{
"code": "200000",
"data": [
{
"symbol": "REQ-ETH",
"name": "REQ-ETH",
"baseCurrency": "REQ",
"quoteCurrency": "ETH",
...
},
{
"symbol": "BTC-USDC",
"name": "BTC-USDC",
"baseCurrency": "BTC",
"quoteCurrency": "USDC",
...
},
...
Get trading data
When the websocket connection is established send a http POST message:
{
"type": "subscribe", //subscribe or unsubscribe
"topic": "/market/ticker:BTC-USDT,BTC-USDC"
}
maybe this answer will not please you at all, but i will try, most of the people who work from the API in KuCoin do it with python, in fact the SDK for Nodejs is out of date, your best bet is to ask in the telegram channel https://t.me/KuCoin_API, there are KuCoin engineers who always help, although most of them use python, there is also the academy channel https://t.me/kucoin_learning, where there are examples, in short I can only mention references because I was also where you are, and the best I could do was that and review the SDk code and from there intuit and create my own adjustments
PD: the datafeed.js file is your best option, check it out https://github.com/Kucoin/kucoin-futures-node-sdk/blob/master/src/lib/datafeed.js
I am trying to build a custom connector for the Rasa chatbot framework and MessageBird messaging service, specifically for Whatsapp Business channel. I have taken a look into Python SDK for MessageBird, and I don't see WhatsApp template messages (or Highly Structured Messages in MessageBird's definition) supported anywhere in it.
Am I mistaken? Or the current version of the MessageBird's SDK really supports only non-structured messages, regular SMS-es?
Thanks in advance for your help.
There is a MESSAGE_TYPE_HSM = "hsm" as a selectable type for a conversation message (defined here) and you will have to adapt the content to refer the appropriate HSM template id (see documentation):
"content":{
"hsm": {
"namespace": "5ba2d0b7_f2c6_433b_a66e_57b009ceb6ff",
"templateName": "order_update",
"language": {
"policy": "deterministic",
"code": "en"
},
"params": [
{"default": "Bob"},
{"default": "tomorrow!"}
]
}
Putting it all together, based on the example, it should look something like this:
msg = client.conversation_create_message(args['conversationId'],
{'channelId': args['channelId'], 'type': MESSAGE_TYPE_HSM,
"content":{"hsm": { "namespace": "5ba2d0b7_f2c6_433b_a66e_57b009ceb6ff","templateName": "order_update","language": {"policy": "deterministic","code": "en"},"params": [{"default": "Bob"},{"default": "tomorrow!"}]}}})
Where of course you will have to customize the content to your exact setup.
I try to use flasgger for my simple RESTful API. The API requireds the authentication/authorization and uses the basic authentication to perform any query.
There is really good documentation about Basic Authentication in swagger.io
But how can those settings be implemented in flassger? I've tried to used template to set securityDefinitions into swaggler, but the attempt hasn't been successful yet.
UPD. Probably the issue hasn't been resolved yet. Flasgger doesnt support basic auth #103
I've resolved the issue of authentication adding the next code:
swagger_template = {
# Other settings
'securityDefinitions': {
'basicAuth': {
'type': 'basic'
}
},
# Other settings
}
app = Flask(__name__)
Swagger(app, swagger_config, template=swagger_template)
Thanks for Dimaf's answer, helped me a lot. Just want to update the new version, in case someone else run into the same problem.
For Swagger 3.0, the config has been updated to the following (this example is for bearer authorization):
swagger_template = {
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"in": "header",
}
}
}
}