Skip to content
This repository was archived by the owner on Jun 11, 2019. It is now read-only.

Commit 5e83a21

Browse files
committed
Merge pull request #107 from harvesthq/update-readme
Readme updates
2 parents 54af9ad + df93039 commit 5e83a21

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ If you need to access and edit your projects, clients, users and tasks the exten
66

77
Remember to write your application carefully, caching when possible. In case of abuse you may be blocked, disallowing further API access. As an act of courtesy, please provide User-Agent strings denoting your application.
88

9-
## Get the Help You Need
9+
## Troubleshooting
1010

11-
Have a question about using the API? Have you noticed an error or omission in the documentation? Feel free to [open an issue](http://github.com/harvesthq/api/issues/) with your question. If you're running into problems with a specific implementation, however, it's best to [get in touch with us directly](http://www.getharvest.com/help/contact) in support (that way we can work with you, checking the logs for specific requests and responses).
11+
If you're running into problems with a specific implementation, it's best to try the request in a client like [Postman](https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en) to try to narrow down where things are going wrong. If you're still having trouble, [drop us a line.](http://www.getharvest.com/help/contact) Please make sure to include the full request you're having trouble with, including any headers, so we can investigate the issue for you.
12+
13+
In many cases, the omission of the ```Content-Type``` and ```Accept``` headers are the root cause of unexpected errors from the API.
1214

1315
## Sample Code & Examples
1416

@@ -34,7 +36,7 @@ Harvest will check your role on each request, and actions that are unavailable t
3436

3537
The Harvest API supports both XML and JSON data formats.
3638

37-
For an XML request, send `application/xml` in the `Accept` and `Content-Type` headers. Send `application/json` for JSON responses. All examples in this documentation assume XML input and output. JSON output follows similar structure to the XML documented, with the notable exception that '-' are typically '_' (for example projects require a client_id rather than client-id).
39+
For an XML request, send `application/xml` in the `Accept` and `Content-Type` headers. Send `application/json` for JSON responses. All examples in this documentation assume XML input and output, however JSON output follows similar structure to the XML documented.
3840

3941
## Throttle Limit - HTTP 503
4042

@@ -60,6 +62,7 @@ A few of our users have implemented their own Harvest API wrappers. If you plan
6062

6163
* Ruby: [Harvested](https://github.com/zmoazeni/harvested), by Zach Moazeni
6264
* Python: [Harvest Time Tracking API Client](https://github.com/lionheart/python-harvest), by Lionheart Software
65+
* Python: [Harvest API Wrapper](http://github.com/lann/Harvest), by Lann Martin and Brian Glass
6366
* Java: [Harvest Time Tracker Console Client](http://github.com/moffermann/harvest-client), by Mauricio Offermann
6467
* Java: [Harvest Java Wrapper](https://github.com/dmmikkel/harvestclient), by Dag Martin Mikkelsen
6568
* PHP: [HaPi - PHP Harvest API](http://mdbitz.com/harvest-api/), by Matthew Denton

0 commit comments

Comments
 (0)