<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>5.6. APIs — Bugzilla 5.0.4 documentation</title>
<link rel="stylesheet" href="../_static/bugzilla.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '5.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="6. WebService API Reference" href="../api/index.html" />
<link rel="prev" title="5.5. Extensions" href="extensions.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../api/index.html" title="6. WebService API Reference"
accesskey="N">next</a></li>
<li class="right" >
<a href="extensions.html" title="5.5. Extensions"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">5. Integration and Customization Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="apis">
<span id="api-list"></span><h1>5.6. APIs<a class="headerlink" href="#apis" title="Permalink to this headline">¶</a></h1>
<p>Bugzilla has a number of APIs that you can call in your code to extract
information from and put information into Bugzilla. Some are deprecated and
will soon be removed. Which one to use? Short answer: the
<a class="reference internal" href="../api/index.html#apis"><span class="std std-ref">REST WebService API v1</span></a>
should be used for all new integrations, but keep an eye out for version 2,
coming soon.</p>
<p>The APIs currently available are as follows:</p>
<div class="section" id="core-module-api">
<h2>5.6.1. Core Module API<a class="headerlink" href="#core-module-api" title="Permalink to this headline">¶</a></h2>
<p>Most of the core Bugzilla modules have extensive documentation inside the modules
themselves. You can view the <a class="reference external" href="../integrating/api/index.html">POD documentation</a> to help with
using the core modules in your extensions.</p>
</div>
<div class="section" id="ad-hoc-apis">
<h2>5.6.2. Ad-Hoc APIs<a class="headerlink" href="#ad-hoc-apis" title="Permalink to this headline">¶</a></h2>
<p>Various pages on Bugzilla are available in machine-parseable formats as well
as HTML. For example, bugs can be downloaded as XML, and buglists as CSV.
CSV is useful for spreadsheet import. There should be links on the HTML page
to alternate data formats where they are available.</p>
</div>
<div class="section" id="xml-rpc">
<h2>5.6.3. XML-RPC<a class="headerlink" href="#xml-rpc" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla has an <a class="reference external" href="../integrating/api/Bugzilla/WebService/Server/XMLRPC.html">XML-RPC API</a>.
This will receive no further updates and will be removed in a future version
of Bugzilla.</p>
<p>Endpoint: <code class="file docutils literal"><span class="pre">/xmlrpc.cgi</span></code></p>
</div>
<div class="section" id="json-rpc">
<h2>5.6.4. JSON-RPC<a class="headerlink" href="#json-rpc" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla has a <a class="reference external" href="../integrating/api/Bugzilla/WebService/Server/JSONRPC.html">JSON-RPC API</a>.
This will receive no further updates and will be removed in a future version
of Bugzilla.</p>
<p>Endpoint: <code class="file docutils literal"><span class="pre">/jsonrpc.cgi</span></code></p>
</div>
<div class="section" id="rest">
<h2>5.6.5. REST<a class="headerlink" href="#rest" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla has a <a class="reference internal" href="../api/index.html#apis"><span class="std std-ref">REST API</span></a> which is the currently-recommended API
for integrating with Bugzilla. The current REST API is version 1. It is stable,
and so will not be changed in a backwardly-incompatible way.</p>
<p><strong>This is the currently-recommended API for new development.</strong></p>
<p>Endpoint: <code class="file docutils literal"><span class="pre">/rest</span></code></p>
</div>
<div class="section" id="bzapi-bzapi-compatible-rest">
<h2>5.6.6. BzAPI/BzAPI-Compatible REST<a class="headerlink" href="#bzapi-bzapi-compatible-rest" title="Permalink to this headline">¶</a></h2>
<p>The first ever REST API for Bugzilla was implemented using an external proxy
called <a class="reference external" href="https://wiki.mozilla.org/Bugzilla:BzAPI">BzAPI</a>. This became popular
enough that a BzAPI-compatible shim on top of the (native) REST API has been
written, to allow code which used the BzAPI API to take advantage of the
speed improvements of direct integration without needing to be rewritten.
The shim is an extension which you would need to install in your Bugzilla.</p>
<p>Neither BzAPI nor this BzAPI-compatible API shim will receive any further
updates, and they should not be used for new code.</p>
</div>
<div class="section" id="rest-v2">
<h2>5.6.7. REST v2<a class="headerlink" href="#rest-v2" title="Permalink to this headline">¶</a></h2>
<p>The future of Bugzilla's APIs is version 2 of the REST API, which will take
the best of the current REST API and the BzAPI API. It is still under
development.</p>
<hr class="docutils" />
<p>This documentation undoubtedly has bugs; if you find some, please file
them <a class="reference external" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">here</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/bugzilla.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">5.6. APIs</a><ul>
<li><a class="reference internal" href="#core-module-api">5.6.1. Core Module API</a></li>
<li><a class="reference internal" href="#ad-hoc-apis">5.6.2. Ad-Hoc APIs</a></li>
<li><a class="reference internal" href="#xml-rpc">5.6.3. XML-RPC</a></li>
<li><a class="reference internal" href="#json-rpc">5.6.4. JSON-RPC</a></li>
<li><a class="reference internal" href="#rest">5.6.5. REST</a></li>
<li><a class="reference internal" href="#bzapi-bzapi-compatible-rest">5.6.6. BzAPI/BzAPI-Compatible REST</a></li>
<li><a class="reference internal" href="#rest-v2">5.6.7. REST v2</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="extensions.html"
title="previous chapter">5.5. Extensions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../api/index.html"
title="next chapter">6. WebService API Reference</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../api/index.html" title="6. WebService API Reference"
>next</a></li>
<li class="right" >
<a href="extensions.html" title="5.5. Extensions"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >5. Integration and Customization Guide</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
