You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think the language can/should be tweaked so that it's more clear that we support any language that can make JSON HTTP calls (every modern language), and that the API is just JSON over http.
For me, this is most prominent in two places:
"Official" language support: maybe weaken this, we don't want to make it seem like other languages aren't going to work for some reason. My suggestion: change to "BlockCypher Supported Language SDKs" or "Officially Supported Language SDKs" to make it clear that the support is for the language library, not the language itself. Maybe additionally, make it explicit that we support any language that can make HTTP calls and parse JSON.
Frequent use of "cURL" : to experienced readers, curl is more or less a synonym for "GET over HTTP", but for inexperienced readers this may seem like some magic tool and the connection may not be obvious.
For example:
If not, or you’d rather write your own bindings, we always support cURLing endpoints directly, which is the default code sample you’ll see to the right.
My suggestion would be something along the lines of:
Of course, all our API's are standard HTTP endpoints using JSON formatted responses, so any language (or cURL from the command-line) will work just fine.
The text was updated successfully, but these errors were encountered:
Great feedback @hbcheng, many thanks. Both 1) and 2) make sense to change immediately (will do that now). I'll keep this issue open for now, and once I've got the skeleton done for the rest of the documentation, I'll modify the language in the introduction to make it clearer that the API is just JSON over HTTP.
Closing this out for now Bryan---think I did a decent job making this explicitly clear for the rest of the docs, but if you think it can be sharpened up let me know by re-opening and I'll take another pass at it.
Tag @matthieu, @Catheryne for discussion:
I think the language can/should be tweaked so that it's more clear that we support any language that can make JSON HTTP calls (every modern language), and that the API is just JSON over http.
For me, this is most prominent in two places:
"Official" language support: maybe weaken this, we don't want to make it seem like other languages aren't going to work for some reason. My suggestion: change to "BlockCypher Supported Language SDKs" or "Officially Supported Language SDKs" to make it clear that the support is for the language library, not the language itself. Maybe additionally, make it explicit that we support any language that can make HTTP calls and parse JSON.
Frequent use of "cURL" : to experienced readers, curl is more or less a synonym for "GET over HTTP", but for inexperienced readers this may seem like some magic tool and the connection may not be obvious.
For example:
My suggestion would be something along the lines of:
The text was updated successfully, but these errors were encountered: