API:Data formats/fr

Entrées
L'API récupère ses entrées à partir des paramètres fournis dans la requête HTTP dans le format  ou. Chaque module et chaque sous-module a sa propre liste de paramètres, qui sont listés dans la documentation et dans action=help. Ils peuvent également être récupérés par.

Encodage
Toute entrée doit être du UTF-8 valide, sous la forme NFC. MediaWiki essayera de convertir les autres formats ce qui pourra éventuellement générer des erreurs.

Paramètres multi-valeurs
Les parameters qui prennent plusieurs valeurs sont normalement envoyés avec les valeurs séparées par une barre verticale (caractèpre pipe ), par exemple. Si une valeur contient le charactère pipe lui-même, utilisez U+001F (séparateur unitaire) comme séparateur et préfixez la valeur avec U+001F, par exemple.

Pour savoir si un paramètre accepte plusieurs valeurs, lisez explicitement la documentation du module.

Paramètres booléens
Si un paramètre booléen figure dans une requête HTTP, il est considéré à true quelquesoit sa valeur. Pour que sa valeur soit false, il suffit de ne pas le fournir. La meilleure manière de spécifier une valeur à vrai dans une requête HTTP est d'utiliser ; ce qui suit le   assure que l'explorateur où la bibliothèque HTTP ne supprimera pas le "vide" de unParam.

Horodatages
Les paramètres qui contiennent des valeurs de références horaires (horodatage), acceptent des valeurs de temps sous différents formats :


 * format ISO 8601:.
 * Format de l'horodatage interne MySQL:.
 * Format de l'horodatage UNIX  (nombre de secondes depuis le 1er janvier 1970).
 * Format de l'horodatage UNIX  (nombre de secondes depuis le 1er janvier 1970).

En sortie, les horodatages sont toujours au format ISO 8601.

Sortie
Le format de sortie standard et par défaut de MediaWiki est JSON. Tous les autres formats ne sont pas recommandés.

Le format de sortie doit toujours être spécifié en utilisant  avec yourformat égal à l'une des valeurs suivantes :



Réponse
Tous les modules permettent d'utiliser n'importe quel format générique pour les informations de sortie - sauf indication contraire. Pour simplifier le débogage, tous les formats génériques possèdent aussi l'option « mise en forme HTML améliorée pour l'impression » avec le suffixe  par exemple.

Paramètres JSON
Les paramètres suivants peuvent être utilisés avec  et   :



Notes supplémentaires

 * les formats de sortie XML et PHP sont obsolètes mais encore utilisés. Les clients écrits en PHP doivent éviter d'utiliser le format PHP parce qu'il n'est pas sécurisé. Il est gardé pour l'instant simplement à cause de sa popularité.
 * Il existe beaucoup de bibliothèques de conversion et de convertisseurs en ligne pour transformer les réponses JSON en d'autres formats; par exemple, JSON-CSV convertit en liste de valeurs séparées par des virgules.
 * Les modules de flux tels que les flux des modifications récentes réécrasent le format standard de sortie, au lieu d'utiliser RSS ou Atom, comme spécifié par leur paramètre  . Dans ces cas, le format spécifié par le paramètre   n'est utilisé que s'il y a une erreur.

Voir aussi

 * - contient des formats pour les avertissements et les erreurs.