L'API

Introduction

Cette page documente la version 1.0 de l'API et présente l'ensemble de ses possibilités.
Toutefois certaines actions peuvent n'être possible que si vous avez le bon profil utilisateur, ou le bon type de contrat : veillez à bien lire les remarques associées à chaque appel.

Remarques

• Pour l'heure, seules des requêtes de type GET sont acceptées.
• Quelque soit la requête un tableau est retourné, que soit une liste ou non par exemple :
  • /api/v1.0/dechet => récupération d'une liste de déchet ; l'API vous donne

    [
        {
            "id_type_dechet": 2,
            "nom": "Pile",
            "rubrique": "20 01 33*",
            "trigramme": "PIL"
        },
        {
            "id_type_dechet": 3,
            "nom": "DEEE",
            "rubrique": "20 01 35*",
            "trigramme": "DEE"
        }
    ]

  • /api/v1.0/dechet/2 => récupération du déchet 2 ; l'API vous donne

    [
        {
            "id_type_dechet": 2,
            "nom": "Pile",
            "rubrique": "20 01 33*",
            "trigramme": "PIL"
        }
    ]

Les APIs

/api/v1.0/auth/time

Permet de récupérer l'heure du serveur ; format timetamp unix.
Il est à noter que le serveur est synchronisé sur un serveur de temps.
Exemple de retour :

1542193437

/api/v1.0/auth/check

Cet appel vous permet de vérifier que tout fonctionne bien en ce qui concerne l'authentification et vos appels à l'APIs.
Voici sur un simple GET les retours possibles :

• quand tout se passe bien

  {
    "check": true
  }

• quand le mot de passe est invalide, le compte/client/application n'existe pas

  {
   "message": "Wrong credentials"
  }

• quand le décalage entre l'heure du serveur et le client est trop grand

  {
   "message": "Wrong timestamp"
  }

• quand l'horodatage d'une requête n'est pas supérieur à la précédente ; i.e. le timestamp de la requpete est inférieur ou égale à celui de la précédente requête

  {
   "message": "Wrong mtimestamp"
  }

Mais il est également possible de valider le passage de paramètres :

• avec GET /api/v1.0/auth/check?display=full

  {
      "display": "full"
  }

• avec POST /api/v1.0/auth/check et le corps suivant : {"display" : true}

  {
      "display": true
  }

/api/v1.0/dechet/{id?}

Cet appel vous permet d'accéder aux déchets.
Exemples de retour :

[
    {
        "id_type_dechet": 2,
        "nom": "Pile",
        "rubrique": "20 01 33*",
        "trigramme": "PIL"
    },
    {
        "id_type_dechet": 3,
        "nom": "DEEE",
        "rubrique": "20 01 35*",
        "trigramme": "DEE"
    }
]