So far I have been using the php client. The issue is that the documentation for it is very poor. I'd like to switch over to use the RestApi. Is there some example of calling the Rest API from php? I actually use CodeIgniter.
dan last edited by
Hi @richb201 ,
Sorry to hear the php client isn't working for you. When I'm developing, I bounce back and forth between the rest API documentation (for how to build the json structures) and the client library source (for what methods to call on the client lib). It's suboptimal, but the best workflow I've found so far (I am looking at alternatives, but nothing decided yet).
You can actually look at the source code for the php client lib and see how it calls the REST API. I haven't worked with code igniter but I imagine you'd do something similar.
Do you have specific suggestions on how to improve the client library docs?
Things I'm considering:
- adding more examples
- using type suggestions (for dynamic languages) if possible
- a playground where you can run the API call and see the result
As a php programmer (and as a C developer before that) I am very reliant on examples. I think this is true of most programmers. I appreciate your help and think you must have a tough job due to the lack of documentation for developers. nice web site, though! I surely would much rather follow the docs than to keep having to ask questions due to vague comments such as "include all the fields that are needed" in the documentation. You can save yourself a huge amount of effort! I have developed using Google Oauth2 and I would say their documentation is possibly a little better. But not much.
So to answer your question, I'd say examples are key. You guys clearly spent some effort on the php client but I feel like I am flying blind. Perhaps a document for php developers on how to use the client would be good. Another idea is to stick with the RestAPI stuff but at least give an example of how to call the restAPI from other languages.
For me the playground would not be helpful since I use the php xdebug as my playground. Just give plenty of examples showing how to do the basic stuff.
dan last edited by
Thanks for your feedback!