API Client SDKs

If you don't see your language of choice above, don't worry, if you have ever written software for the web, you should have no problem using our REST API. At the very least, the above should be able to search as a low-level roadmap for your own implementation. See below for the details of how to communicate with the
GitShare API.

Debugging

Our API uses webhooks to notify you of completion. To debug webhooks, we recommend using a service like RequestBin. You can give us your RequestBin as the webhook URL, you can then later inspect the request we made to that URL. This will help you to develop your own webhook handler.

Use the links on the left to navigate our live documentation. Caution this is the live api. Try some tests using the forms and HTTP method buttons. The actual results of your tests will show in the response box. The HTTP status codes also show above the response box.

Turn on your development tools, such as Firebug, and use the links on the left to navigate. Once you select the resource you need, you can inspect the fields on the page to determine the field name. The field names used in the form are the same parameters you will be passing the api via your chosen client SDK.

Rate Limiting

The GitShare API uses rate limiting to prevent abuse. This means we allow 250 requests per minute
to allow short bursts of activity and prevent prolonged bursts of requests. The server returns a
503 status when the rate of API requests surpasses the specified limit.

You can use the X-Throttle header to see when you will be under the throttle limit again.

Response Format

You are able to specify the response format with the format parameter. Here are some of the available response formats:

csv – Returns response in comma separated format with text/plain content-type. This is only available for the Activity resource.

API Version

To select a version of the api use the version number as the second part of the url. (Example: /api/2.0/) You can ensure you are always using the latest version of the api by leaving off the subversion. (Example: /api/2/)

API version 2.2 is an upgrade to 2.1 with pagination on most list endpoints.

API version 2.1 is an upgrade to 2.0 that uses path strings instead of ids for paths.

Messages

Welcome Message NEW

Welcome to GitShare! We encourage you to explore and use the GitShare Platform to build something amazing. This is a free Beta version that will be available for an indefinite amount of time. Be proud you're an early adopter and taking advantage of a great opportunity to utilize this service for FREE! We'll contact you through here (messages) is we have more to say...