API

Méthodes

Liste des méthodes appelables

• liste : renvoie la liste des enregistrements d'un objet donné
• ajouter : ajoute un enregistrements
• modifier : modifier un enregistrement
• supprimer : supprime un enregistrement
• incrementer : incrémente un nombre

Méthode liste

Cette méthode renvoie la liste des enregistrements dans un format JSON.

Paramètres obligatoires

• api_key : clé du compte
• obj_id : identifiant de l'objet

Retour (JSON)

Un message JSON listant l'ensemble des enregistrements

{
    "total": 1,
    "items": [
      {
        "id": 00001,
        "titre": "Exemple de réponse",
        "creation_date": "1480154968",
        "creation_date_timestamp": 0,
        "last_updated": "1481102370",
        "last_updated_timestamp": 0,
        "attribut_1": "2",
        "attribut_2": 1,
        "attribut_3": "1",
      }
    ]
  }

Méthode ajouter

Cette méthode ajoute un enregistrement.

Paramètres obligatoires

• api_key : clé du compte
• obj_id : identifiant de l'objet

Retour (JSON)

Un champ "enregistrement" contenant l'ensemble des attributs de l'objet créé est renvoyé.

{
    "total": 1,
    "items": [
      {
        "id": 00001,
        "titre": "Exmple d'ajout",
        "creation_date": "1480154955",
        "creation_date_timestamp": 0,
        "last_updated": "1480154955",
        "last_updated_timestamp": 0,
        "attribut_1": "2",
        "attribut_2": 1,
        "attribut_3": "1",
      }
    ]
}

Méthode modifier

Cette méthode modifie un enregistrement.

Paramètres obligatoires

• api_key : clé du compte
• obj_id : identifiant de l'objet

Retour (JSON)

Un champ "success" à true si l'action a bien été réalisée, false sinon.

{
    "success": true
  }

Méthode supprimer

Cette méthode supprime un enregistrement.

Paramètres obligatoires

• api_key : clé du compte
• obj_id : identifiant de l'objet

Retour (JSON)

Un champ "success" à true si l'action a bien été réalisée, false sinon.

{
    "success": true
}

Méthode incrémenter

Cette méthode incrémente de + 1 un attribut d'objet.

Paramètres obligatoires

• api_key : clé du compte
• obj_id : identifiant de l'objet
• att_id : attribut à incrémenter

Retour (JSON)

Un champ "success" à true si l'action a bien été réalisée, false sinon.

{
    "success": true
}