Please, please fix up your API documentation

50 views
Skip to first unread message

PuffinMojo

unread,
Mar 25, 2019, 3:00:29 PM3/25/19
to Remember The Milk API
Guys, this is 2019 and the documentation, I'm sorry to say truly sucks. I never criticise other developers publicly normally, but this really isn't good enough in terms of finding what I need quickly.

From first impressions, I should be able to write a flow to get my own tasks into RTM using an API, i.e Postman requests.

I shouldn't have to go through third party code samples to write a simple Postman REST request to try and integrate with the apps.

Please can you update your docs to unambiguously define your methods, in particular showing the specifics of a given request.

As a great example, your section on auth:


Is the signature I'm building based off my secret and the params to the method, or the api_key, and the other params, and the hash of the api_secret? My point is it's not clear because that page only loosely makes reference to the exact request url.


And when should I use the auth_token parameter? Does that need to form part of a signature?

Sorry if I'm coming across frustrated, but I write APIs myself at work, and I'd never be allowed to write such little documentation. If I've missed some more comprehensive documentation linked off your site, I apologise, but please show me where it is in that case.

Thanks
Reply all
Reply to author
Forward
0 new messages