Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/userguide/conduit.diviner
@title Conduit API Overview | @title Conduit API Overview | ||||
@group conduit | @group conduit | ||||
Overview of the Conduit API. | Overview of the Conduit API. | ||||
Overview | Overview | ||||
======== | ======== | ||||
Conduit is the HTTP API for Phabricator. It is roughly JSON-RPC: you usually | Conduit is the HTTP API for Phorge. It is roughly JSON-RPC: you usually | ||||
pass a JSON blob, and usually get a JSON blob back, although both call and | pass a JSON blob, and usually get a JSON blob back, although both call and | ||||
result formats are flexible in some cases. | result formats are flexible in some cases. | ||||
API Clients | API Clients | ||||
=========== | =========== | ||||
The primary ways to make Conduit calls are: | The primary ways to make Conduit calls are: | ||||
**Web Console**: The {nav Conduit} application provides a web UI for exploring | **Web Console**: The {nav Conduit} application provides a web UI for exploring | ||||
the API and making calls. This is the best starting point for learning about | the API and making calls. This is the best starting point for learning about | ||||
the API. See the next section for details. | the API. See the next section for details. | ||||
`ConduitClient`: This is the official client available in `arcanist`. | `ConduitClient`: This is the official client available in `arcanist`. | ||||
`arc call-conduit`: You can use this `arc` command to execute low-level | `arc call-conduit`: You can use this `arc` command to execute low-level | ||||
Conduit calls by piping JSON in to stdin. This can provide a simple way | Conduit calls by piping JSON in to stdin. This can provide a simple way | ||||
to explore the API, or a quick way to get API access from a script written | to explore the API, or a quick way to get API access from a script written | ||||
in another language without needing a real client. | in another language without needing a real client. | ||||
`curl`: You can format a call with basic HTTP parameters and cURL. The console | `curl`: You can format a call with basic HTTP parameters and cURL. The console | ||||
includes examples which show how to format calls. | includes examples which show how to format calls. | ||||
**Other Clients**: There are also clients available in other languages. You | **Other Clients**: There are also clients available in other languages. You | ||||
can check the [[ https://secure.phabricator.com/w/community_resources/ | | can check the [[ https://we.phorge.it/w/community_resources/ | | ||||
Community Resources ]] page for links. | Community Resources ]] page for links. | ||||
API Console | API Console | ||||
=========== | =========== | ||||
The easiest way to begin exploring Conduit is by visiting {nav Conduit} in the | The easiest way to begin exploring Conduit is by visiting {nav Conduit} in the | ||||
web UI. The application provides an API console which you can use to explore | web UI. The application provides an API console which you can use to explore | ||||
available methods, make calls, read documentation, and see examples. | available methods, make calls, read documentation, and see examples. | ||||
Show All 26 Lines |
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0