diff --git a/help/fr/api-cards.page b/help/fr/api-cards.page index d1d66145e..8bbc131e7 100644 --- a/help/fr/api-cards.page +++ b/help/fr/api-cards.page @@ -12,13 +12,104 @@ -Récupération des données de fiches +Gestion des fiches

-Une application tierce peut récupérer les données des fiches, peut également -obtenir la liste des modèles de fiche et les schémas de données associés. +Une application tierce peut créer des fiches, récupérer les données des fiches, +et peut également obtenir la liste des modèles de fiche et les schémas de +données associés.

+
+ Création d'une fiche + +

+ La création d'une fiche se fait par une requête POST à + l’adresse /api/cards/slug/submit, le contenu de + la requête doit être un dictionnaire contenant obligatoirement un attribut + data. +

+ +

+ L’attribut data est obligatoire et contient un dictionnaire + dont les clés sont les noms de variable (remplacé ici par + varname) des champs de la fiche et les valeurs le contenu de + ces champs. +

+ + + +

+ Les champs de type simple tels que « Texte », « Texte long » ou + « Courriel » sont des chaînes de caractères. +

+
+ + +

+ Les champs de type « Liste » et « Liste à choix multiples » acceptent + différentes valeurs selon leur configuration, ceci est décrit dans + . +

+
+ + +

+ Les champs de type « Date » sont des chaînes de caractères au format + ISO-8601, i.e. YYYY-MM-DD. +

+
+ + +

+ Les champs de type « Fichier » sont des dictionnaires contenant les clés + filename pour le nom de fichier et content pour le + contenu de celui-ci, encodé en base64. +

+
+ + +

+ Les champs de type « Carte » sont des dictionnaires contenant les clés + lat pour la latitute en nombre décimal et lon + pour la longitude en nombre décimal. +

+
+
+ +

+ L’exemple suivant crée une fiche « Parking », dont le modèle + de fiche a comme identifiant « parkings », qui demanderait trois champs : + adresse (nom de variable adresse), date d'ouverture + (nom de variable date_ouverture) et nom (nom de variable + nom). +

+ + +$ curl -H "Content-type: application/json" \ + -H "Accept: application/json" \ + -d@donnees.json \ + https://www.example.net/api/cards/parkings/submit?signature… +{"err": 0, "data": {"id": "5"}} + + +

+ Le fichier de données utilisé (donnees.json) contient le + dictionnaire JSON suivant : +

+ + +{ + "data": { + "adresse": "rue de l’Opéra", + "date_ouverture": "2020-11-12", + "nom": "Parking Opéra-Tolozan" + } +} + + +
+
Récupération des données d’une fiches @@ -64,8 +155,7 @@ Le contenu ainsi obtenu est le suivant :

-La structure du contenu correspond à celle de l’API d -récupération des données d’un formulaire. +La structure du contenu correspond à celle de l’API de .