Documentation technique

Gestion des projets

Accédez aux informations concernant vos projets.

Votre tableau de bord

Votre tableau de bord, première page affichée lors de votre authentification, vous permet d’avoir la vision sur les sites que vous gérez et également les remontées d’alerte sur vos projets (problème lors d’un export par exemple).

Si un des projets que vous gérez pose souci, un message est affiché directement sur cette page. Ce message est affiché à la fois pour le propriétaire et les collaborateurs du projet en erreur.

Menu Diffuser

dev-diffuser

La section Diffuser centralise l’ensemble des outils dont vous avez besoin pour faire votre travail de développeur technique Apidae :

  • Mes projets : accès à l’ensemble des projets sur lesquels vous êtes développeur. C’est votre client qui vous déclare comme développeur sur le projet.
  • Mes sélections et Mes filtres : permet de gérer le contenu des sites si vous avez la permission de le faire ou de le consulter.
  • Outils développeurs : tous les outils vous permettant de mieux comprendre/exploiter la donnée Apidae.

Mes projets

Vos clients vous déclarent comme développeur sur les projets sur lesquels vous êtes amenés à intervenir. A partir du moment où cette démarche a été faite, vous avez accès au projet. Cet accès peut être plus ou moins complet :

  • Consultation seule : vous pouvez visualiser l’ensemble des données du projet mais vous ne pouvez pas les modifier ;
  • Configuration technique : vous pouvez modifier la configuration technique du projet : forme des exports, type de projet, phase du projet…
  • Configuration technique et contenu : vous pouvez aussi définir des sélections, filtres et marquages web.

De manière générale, nous essayons de faire en sorte que vous ayez toutes les informations nécessaires pour faire votre travail directement dans nos interfaces. Il est souhaitable que, de votre côté, vous indiquiez à quoi sert votre projet et dans quelle phase il est. Cela nous permet d’allouer les ressources intelligemment en priorisant les projets en production par rapport aux projets en cours de développement.

Projet de test

Les projets de test sont mis à disposition pour vous permettre d’expérimenter les exports et les API Apidae.

Ces projets sont limités en nombre d’objets et bénéficient de priorités de traitement moindre que les projets standards. Le nombre de projet test est limité à un par membre. A la création du projet, une première sélection avec un filtre portant sur le territoire donné sera créée automatiquement. Vous pourrez reconfigurer supprimer ou reconfigurer cette sélection une fois le projet créé. Vous êtes encouragés à utiliser ces projets pour découvrir et expérimenter les outils fournis par Apidae.

En résumé, les règles suivantes s’appliquent :

  • les projets de test sont non prioritaires et traités en fin de cycle d’export ; aucune garantie de service n’est donnée pour les projets de test ;
  • tout projet destiné à être utilisé « en production » doit donner lieu à la création d’un projet normal validé par le réseau Apidae ;
  • les projets de test sont désactivés périodiquement s’ils ne sont pas reconfigurés pendant 6 semaines (cette désactivation donne lieu à une notification par mail ; il vous est alors possible de réactiver votre projet simplement en accédant à sa fiche) ;
  • le nombre total d’objets est limité à 200 par sélection via les API ;
  • le nombre total d’objets est limité à 1 000 via les exports ;
  • vous ne pouvez posséder qu’un seul projet test ; les objets démonstration (utilisés à fin d’exemple et démonstration) sont inclus dans les projets test ; ces objets n’ont pas vocation à être diffusés au public et ne sont pas inclus dans les projets standards.

Les projets de test ne doivent jamais être utilisé pour un projet production. Pour cela, pensez à créer un projet classique.

Opérations exceptionnelles

projet-operations-exceptionnelles

Dans l’interface développeur de l’application Apidae, un développeur à la possibilité d’effectuer un certain nombre d’actions concernant les sélections et les exports pour leur site web. Comme leur nom l’indique, ces actions doivent absolument rester exceptionnelles.

Demander un calcul des sélections et/ou un export ponctuel

Cette action doit rester exceptionnelle.

Le responsable technique d’un projet (propriétaire ou collaborateur) peut demander un calcul des sélections et/ou un export ponctuel, si par exemple, l’export périodique des données pour son site web a échoué et qu’il ne veut pas attendre le prochain cycle. Ces tâches ponctuelles sont réalisées durant la phase d’attente du cycle, indépendamment des exports périodiques.

Après la demande, la tâche de calcul des sélections et/ou d’export apparaît dans le tableau dans l’état d’attente. Ce tableau permet d’effectuer un suivi de du calcul et/ou de l’export.

Dans le cas d’un export ponctuel, il est possible :

  • de choisir si cet export doit devenir la référence pour le prochain export périodique ;
  • si l’export doit être différentiel ou complet ;
  • si une adresse mail a été renseignée dans les préférences des exports, la fin de l’export est notifiée par mail ;
  • si une url de notification a été renseignée dans les préférences des exports, la fin de l’export est notifiée via l’url de notification.

Demande de réinitialisation (export)

Cette action doit rester exceptionnelle.

Le prestataire peut demander une réinitialisation de ses exports. Cela signifie que, lors du prochain export périodique, un export complet sera réalisé (au lieu d’un export différentiel).

Mes sélections et mes filtres

Ces pages vous permettent de gérer les contenus des sélections si la permission vous a été accordée. A défaut, ces interfaces vous permettent de les consulter. Les documentations utilisateur traitent de la gestion de ces éléments

> Voir tutoriels utilisateur sur la gestion de projet