Topic: Suggestion about documenting your APIs
Hey there!
This will sound a bit like ranting, because I do feel quite frustrated about my own experience with your APIs, but I guess you'll be able to take the positive out of it anyway, so here it goes:
Guys, I'm once again stuck with some undocumented/obscure stuff of yours which my production code should rely on.
This is seriously impacting my productivity. I need to focus on my application needs, instead of having to struggle with the API I'm using.
So, I strongly suggest you, as the software vendor you are, to go through this forum and collect all the typical use cases your API will be normally used to, and then provide short, working examples for each one of them.
You know, any customer of yours will be interested sooner or later in reading his/her data using the APIs to do further processing.
Things like "logging in and logging off", "getting the list of units with their last positions", "getting the list of POIs with their positions", "getting the last message for each one of your items", "getting the routes data" and stuff like that should be simple things to do for those who use your API.
So please, consider my suggestion above and create a bank of practical examples for we all to take advantage of. It's not hard to do, your customers will thank you and we all will win from that in the short term.
Thanks for reading this far!