travis-api/docs/00_overview.md
2013-11-07 15:27:07 +01:00

27 lines
1.2 KiB
Markdown

# Overview
**This documentation is for the v2 API. However, this endpoint does also serve the v1 API (undocumented).**
Welcome to the Travis CI API documentation. This is the API used by the official
[Travis CI](https://travis-ci.org) web interface, so everything the web
interface is able to do is also accomplishable via the API.
## Media Types
The API is currently [JSON](http://en.wikipedia.org/wiki/JSON) only.
## Clients and Libraries
Official, maintained by the Travis CI team:
* **[Travis Web](https://github.com/travis-ci/travis-web)**: Web interface and JavaScript library, using [Ember.js](http://emberjs.com/)
* **[travis](https://github.com/travis-ci/travis)**: Command line client and Ruby library
Unofficial:
* **[PHP Travis Client](https://github.com/l3l0/php-travis-client)**: PHP client library
* **[Travis Node.js](https://github.com/pwmckenna/node-travis-ci)**: Node.js client library
* **[travis-api-wrapper](https://github.com/cmaujean/travis-api-wrapper)**: Asynchronous Node.js wrapper
* **[travis-ci](https://github.com/mmalecki/node-travis-ci)**: Thin Node.js wrapper
* **[TravisMiner](https://github.com/smcintosh/travisminer)**: Ruby library for mining the Travis API