5.6. API¶
Bugzilla dispose de nombreuses API que vous pouvez appeler à partir de votre code pour extraire des informations ou en injecter dans Bugzilla. Certaines sont obsolètes et seront bientôt retirées. Lesquelles utiliser ? La réponse courte : REST WebService API v1 doit être utilisé pour toutes les nouvelles intégrations, mais gardez un œil sur la version 2 qui sera bientôt publiée.
Les API actuellement disponibles :
5.6.1. Modules API centraux¶
La plupart des modules centraux de Bugzilla contiennent une documentation complète dans les modules eux-mêmes. Vous pouvez consulter la documentation POD pour l'aide à l'utilisation des modules centraux dans vos extensions.
5.6.2. API ad hoc¶
Diverses pages de Bugzilla sont disponibles dans des formats classiques comme le HTML. Par exemple, les bogues peuvent être téléchargés sous forme XML et les listes de bogues sous forme CSV. Le format CSV est utile pour les imports de feuille de tableur. Il existe des liens sur les pages HTML pour d'autres formats alternatifs quand ils sont disponibles.
5.6.3. XML-RPC¶
Bugzilla contient une API XML-RPC. Cette API ne sera plus mise à jour et sera retirée dans une future version de Bugzilla.
Point d'entrée : /xmlrpc.cgi
5.6.4. JSON-RPC¶
Bugzilla dispose d'une API JSON-RPC. Cette API ne sera plus mise à jour et sera retirée dans une future version de Bugzilla.
Point d'entrée : /jsonrpc.cgi
5.6.5. REST¶
Bugzilla dispose d'une API REST qui est l'API actuellement recommandée pour l'intégration avec Bugzilla. La version actuelle de l'API REST est la version 1. Elle est stable et les mises à jour préserveront la compatibilité descendante.
C'est l'API actuellement recommandée pour les nouveaux développements.
Endpoint: /rest
5.6.6. BzAPI et BzAPI compatible avec REST¶
La première API REST pour Bugzilla a été mise en œuvre en utilisant un proxy externe appelé BzAPI. Elle est devenue suffisamment populaire pour qu'une API compatible BzAPI soit ajoutée par dessus l'API REST (native) écrite ensuite, pour permettre au code utilisant l'API BzAPI de tirer avantage des améliorations de performances de l'intégration directe sans avoir besoin de tout ré-écrire. Cette extension peut être nécessaire pour votre installation Bugzilla.
Les API BzAPI et BzAPI-compatible API ne seront plus mises à jour et ne doivent pas être utilisées pour de nouveaux développements.
