Below are tools you may find handy when testing out the features that the API offers. Both of them are very similar in functionality, so no matter which one you choose you should be able to quickly test web resources.

cURL

cURL is a command line client that provides an interface to all the functionalities of the HTTP protocol (and many other features). The following command gets the project with id 1:

$ curl -H 'X-tinyPM-token: 8709725e52ecec50e4ece9e8f718c355' http://localhost:8080/tinypm/api/project/1

This example shows how to update the task:

$ curl -H 'X-tinyPM-token: 8709725e52ecec50e4ece9e8f718c355' -H 'Content-Type: application/xml' -d '<task>...</task>' -X PUT http://localhost:8080/tinypm/api/task/17

switches:
-H an HTTP header to use when accessing a web resource
-d data to send when creating or updating the entity
-X an HTTP method: GET POST PUT DELETE

Poster

Poster is a Firefox plugin which provides easy and intuitive interaction with HTTP resources.

After installing Poster you can run it with small "P" button in the right bottom corner of the Firefox window. Alternatively, you can use Ctrl+Shift+P shortcut to open it in the sidebar.

Now you have a request window, where you can choose URL, HTTP method, etc. and perform an HTTP request. This shows how to update the task.

When you hit "GO" button no 1, you will be asked for headers (put your token there). The "GO" button no 2 will send your request.

If this documentation doesn't solve your problem or has left you with any questions, please don't hesitate to contact us at support@tinypm.com

Helpful tools

cURL

Poster

Labels