Démarrez avec l’intégration API Simple-Simon

Protégez vos données et optimisez vos processus avec l’API Simple-Simon. Suivez ces directives pour une utilisation sûre et efficace.

Two business colleagues have a discussion in the office, focused on the laptop screen, brainstorming.

Principales restrictions :

  • Licence active requise : le nom d’utilisateur et le mot de passe doivent être liés à une licence active pour le mois en cours. Il n’est pas nécessaire qu’il s’agisse d’un utilisateur supplémentaire.
  • Demander l’accès à l’API : envoyez une demande unique au support Simon pour activer l’API. Vous recevrez un e-mail contenant un lien URL et la documentation de chaque méthode.
  • Responsabilité : vous êtes responsable de la protection contre toute utilisation non autorisée ainsi que de l’intégrité et de la qualité de vos données.
  • Coûts : le coût s’élève à €495 par an.

Créer votre propre intégration

Pour mettre en place votre propre intégration, vous avez besoin des éléments suivants :

  1. Code de licence Simon : une clé de licence Simon à 16 chiffres.
  2. Nom d’utilisateur Simon Office : par exemple, l’adresse e-mail utilisée lors de votre demande.
  3. Mot de passe : le mot de passe associé à ce compte utilisateur.
  4. Demande unique : l’accès à l’API doit être demandé une seule fois pour activer l’intégration.
  5. Clé API : vous la recevez par e-mail après votre demande unique.

Informations complémentaires :
Le serveur API de Simple-Simon prend en charge les méthodes HTTP GET, POST, PUT et DELETE ainsi que le protocole OData. SOAP n’est pas pris en charge. L’API est disponible uniquement en anglais, et tous les noms d’entités sont également en anglais.

Own Integration Icon

Principales tables

  • Customer : représente un client. Un client peut avoir un ou plusieurs lieux d’intervention associés.
  • Contact : une personne de contact liée à un client ou à un lieu d’intervention.
  • Location : l’adresse d’intervention ou de travail liée à un bon d’intervention. Un lieu d’intervention peut également exister sans être lié à un client.
  • WorkOrder : le bon d’intervention proprement dit. Chaque bon d’intervention est toujours lié à un lieu d’intervention.
  • Equipment : équipements ou installations enregistrés sur un lieu d’intervention et liés aux bons d’intervention.
  • ItemGroup : un groupe d’articles ou de matériaux, utilisé pour organiser le stock.
  • Item : articles ou matériaux individuels au sein d’un groupe d’articles.
  • User : représente à la fois le personnel de bureau et les techniciens sur le terrain.
  • Planning : contient toujours un lien entre un bon d’intervention et un utilisateur (pour la planification).
  • WorkOrderSurvey : formulaires ou checklists numériques créés dans Simon et liés à un bon d’intervention spécifique.
  • UsedItem : matériaux utilisés ou consommés lors d’un bon d’intervention.
  • TimeSheet : heures de déplacement et de travail associées à un bon d’intervention.
  • Attachment : fichiers ou photos joints à un bon d’intervention, à un lieu d’intervention ou à un client.

Généralités

Pour vous authentifier auprès de l’API Simple-Simon, vous devez d’abord demander un jeton d’accès en appelant le point de terminaison de connexion avec les identifiants suivants :

  • lickey : votre code de licence Simple-Simon à 16 chiffres
  • apiKey : reçue par e-mail
  • password : votre mot de passe utilisateur
  • username : votre nom d’utilisateur Simon (par exemple l’adresse e-mail liée à votre compte)

Une fois l’authentification réussie, vous recevez un jeton bearer que vous devez inclure comme paramètre d’en-tête dans toutes les requêtes API suivantes. Ce jeton a une durée de validité limitée. Dès qu’il a expiré, demandez un nouveau jeton en appelant à nouveau le point de terminaison de connexion, afin d’éviter toute interruption de votre session. Pour tous les détails sur le point de terminaison de connexion, le format des requêtes et des réponses ainsi que l’ensemble des opérations disponibles, consultez la documentation interactive de l’API que vous avez reçue par e-mail.

Méthodologie de Simon

L’API Simple-Simon suit une structure cohérente et uniforme pour toutes les entités. L’exemple suivant utilise la table « Location », qui représente un chantier ou une adresse d’intervention. Il s’applique de la même manière à toutes les autres entités disponibles.
Vous pouvez effectuer les opérations OData suivantes sur les adresses d’intervention :

  • POST : /locations : pour créer un nouveau lieu d’intervention
  • PUT : /locations/{id} : pour mettre à jour un lieu d’intervention précis à l’aide de son ID
  • DELETE : /locations/{id} : pour supprimer un lieu d’intervention précis à l’aide de son ID
  • GET : /locations/{id} : pour récupérer un lieu d’intervention précis à l’aide de son ID
  • GET : /locations : pour récupérer une liste de lieux d’intervention

Vous pouvez utiliser des paramètres de filtre pour affiner les résultats. Le filtrage OData peut être appliqué à toutes les propriétés disponibles. Cliquez ici pour en savoir plus sur le fonctionnement du filtrage OData.

Pour les opérations telles que la mise à jour et la suppression, vous devez indiquer l’ID. Consultez la documentation de l’API pour connaître les filtres pris en charge.

tevreden buitendienst

Conditions d’utilisation de l’API Simple-Simon

Si vous souhaitez utiliser l’API Simple-Simon, les conditions suivantes s’appliquent :

  • Soumettre une demande : envoyez un message au support pour demander l’accès. Nous veillons à ce que votre environnement soit configuré pour l’utilisation de nos API.
  • Licence active : vous devez disposer d’au moins une licence active (payante) pour utiliser l’API. Pendant la période d’essai, l’utilisation de l’API Simple-Simon n’est malheureusement pas possible.
  • À vos propres risques : toute perturbation de votre environnement Simple-Simon, de l’intégration avec votre système ERP et/ou de votre agenda résultant de l’utilisation de l’API relève de votre propre responsabilité.
  • Frais d’assistance : si vous avez besoin de l’assistance de notre équipe informatique, les frais s’élèvent à 1 300 € par jour-homme, avec un minimum d’un jour-homme.
  • Facturation annuelle : les frais d’API sont facturés une fois par an, à l’avance. Dès réception de votre paiement, nous activons votre accès à l’API.

Optimisez votre workflow avec l’API Simple-Simon et intégrez-la facilement à vos systèmes existants !