Proxapi facilite l'accès aux API limitées par des quotas

lundi 08 septembre 2014

Qu'est-ce que c'est ?

Proxapi est une bibliothèque javascript s'interfaçant avec les API de services comme Twitter, Google ou Facebook qui limitent la quantité de requêtes autorisée pour une période donnée. Elle permet de mettre en place différentes stratégies lorsque les quotas sont atteints, comme retourner un message d'erreur informatif ou attendre la fin de la période limitée pour effectuer de nouveau la requête.

Comment ça marche ?

Prenons un appel à l'API de géocodage de google maps, voici un exemple de code, sans Proxapi, qui affiche les coordonnées d'une addresse si tout se passe bien, et le message Erreur: quota atteint si les limites d'utilisation de l'API sont atteintes.

var geocoder = new google.maps.Geocoder();
geocoder.geocode({ 'address': 'Bordeaux, France' }, function(results, status) {
  if (status == google.maps.GeocoderStatus.OK) {
    console.log(results[0].geometry.location);
  } else if (status == google.maps.GeocoderStatus.OVER_QUERY_LIMIT) {
    console.log("Erreur : quota atteint!");
  }
});

Nous allons utiliser Proxapi pour lancer la requête toutes les minutes tant que la réponse indique un blocage pour cause de quotas dépassés. L'initialisation de Proxapi et la requête se font de la manière suivante, le contenu de la fonction translate est détaillé par la suite.

var geocoder_proxy = new Proxapi({
  strategy: 'retry',
  retry_delay: 60, //On tente la requête toutes les minutes
  translate: function(params, proxy_callback){
        //...
        }
};

geocoder_proxy.call({address: 'Bordeaux, France'}, function(err, results){
  if (err) {
    console.log(err);
  } else {
    console.log(results[0].geometry.location);
  }
});

La fonction translate utilisée lors de l'initialisation permet à Proxapi d'interroger l'API du service distant et d'interpréter les résultats en suivant ce scénario :

  • appel à l'API avec les paramètres params qui reprennent ceux fournis à la fonction Proxapi.call ( dans notre exemple : {adress: 'Bordeaux, France'})
  • réception des résultats de la requête
  • détection d'une limite d'utilisation atteinte, interception des autres erreurs
  • retour à Proxapi en appelant la fonction proxy_callback avec les paramètres suivant :
    • err : les erreurs autres que celles liés à la limitation par quota
    • results : le résultat de l'appel à l'API
    • aqm_status : informations concernant la requête, il faut au moins renseigner la valeur aqm_status.quota (true si la requête n'a pu aboutir pour cause de limitation par quota, false sinon).

Voici le code complet. Il suffit de modifier les portions de la fonction translate annotées XXX à modifier pour adapter ce code à une API différente.

var geocoder_proxy = new Proxapi({
  strategy: 'retry',
  retry_delay: 60, //On tente la requête toutes les minutes
  translate: function(params, proxy_callback){ 
    // XXX ligne suivante à modifier (Appel à l'API) :
    geocoder.geocode({'address': params.address}, function(results, status){
      var aqm_status = { quota: false };
      var err = null;

      // Transformation du résulat de l'appel à l'API dans le format de proxy_callback
      // XXX bloc à modifier
      if (status == google.maps.GeocoderStatus.OVER_QUERY_LIMIT) {
        aqm_status.quota = true;
      } else if (status !== google.maps.GeocoderStatus.OK) { 
          err = status;
      }

      //Retour à Proxapi par l'appel final à proxy_callback
      proxy_callback(err, results, aqm_status); 
    });
  }
});

geocoder_proxy.call({address: 'Bordeaux, France'}, function(err, results){
  if (err) {
    console.log(err);
  } else {
    console.log(results[0].geometry.location);
  }
});

Des exemples fonctionnels plus détaillés sont visibles avec code source du projet.