Cette section fournit des pistes et des solutions aux problèmes courants rencontrés par les développeurs lors de la création d'applications.

 Restez sur la bonne voie avec notre changelog

Si vous souhaitez être averti lorsque notre équipe planifie/publie de nouvelles fonctionnalités techniques ou si vous utilisez notre API et que vous voulez vous assurer que notre nouvelle fonctionnalité ne cassera pas votre code, nous vous conseillons de vous abonner au canal changelog.
Mode débogage

Vous pouvez appeler notre API en mode débogage en ajoutant : X-Debug-Boondmanager avec une valeur définie sur true. Cela forcera notre API à signaler en tant qu'erreur toute incohérence dans votre appel d'API qui, autrement, aurait été ignorée.

Problème d'activation de BasicAuth et X-Jwt-Client-Token

Parfois, lorsque vous essayez d'activer BasicAuth et x-jwt-client-token pour un administrateur, vous pouvez obtenir une erreur indiquant un e-mail manquant. Cela est dû au fait que l'identifiant utilisé pour le compte n'est pas une adresse e-mail valide.

Pour pouvoir utiliser BasicAuth et X-Jwt-Client-Token en tant qu'administrateur,l'adresse e-mail utilisée doit être une adresse e-mail valide.

Réécriture d'URL

Une des difficultées auxquelles certains développeurs sont confrontés lors de la création d'une application pour la première fois est la configuration de règles de réécriture d'URL sur leurs serveurs. Voici un lien vers la section d'aide des serveurs Web les plus courants :

Jeton d'authentification

Jetons (token) invalides

Si vous rencontrez des difficultés pour générer un jeton valide, c'est-à-dire que votre requête HTTP reçoit une erreur 401, veuillez consulter cette page et essayez d'utiliser notre code PHP pour tester votre algorithme de génération.

Utilisation de X-Jwt-Client-Boondmanager

Pour pouvoir utiliser X-Jwt-Client-Boondmanager, vous devez activer l'option "Autoriser l'appel aux API Rest via l'authentification X-Jwt-Client". (Administration > Espace développeur > API/Sandbox)

Erreurs HTTP

401

Généralement causé par des informations d'identification incorrectes ou un jeton généré non valide.

404

La page ou fiche appelée n'existe pas (une erreur dans l'ID ou dans votre URL. Solutions possibles : videz le cache / vérifiez la compatibilité des plugins, etc).

501

Causé lors de la tentative d'accès à une API existante mais inactive. Cela signifie que l'API concernée n'est pas ouverte à nos clients.

Certaines API ne sont accessibles qu'en mode "god" (Voir Choisir la bonne méthode d'authentification).

403

Cela signifie que vous ne possédez pas l’autorisation d’appeler spécifiquement cette URL.

405

Généralement causé lors de l'envoi d'une mauvaise requête à une API existante (ex : au lieu d'utiliser /deliveries/6 vous utilisez /deliveries?id=6)

Tester nos API

Le moyen le plus simple de tester notre API est :

  • Activer l'authentification de base ("Basic auth") à partir de ses paramètres pour un manager disposant de suffisamment de droits.
  • Utilisez BoondManager dans votre navigateur avec la console ouverte et vérifiez comment nous demandons notre API.
  • Essayez quelques requêtes GET simples.
  • Testez via Postman avec nos tutos vidéos et notre bibliothèque Postman à votre disposition. (Section Premiers Pas)
God mode

Ce mode est utilisé pour contourner les limitations imposées par les droits de l'utilisateur identifié par le userToken. Certaines API sont restreintes et ne sont accessibles que dans ce mode. Actuellement, ce sont les points finaux dans ce cas :

  • /contracts
  • /advantages

Documents

Certains endpoints de l'API de documents utilisent un modèle d'identification spécifique. Par exemple

  • La lecture d'un document d'id 999 et de type resume (CV d'un candidat ou d'une ressource) se fait en appelant une méthode GET sur /api/documents/999_resume.

Veuillez nous contacter si vous avez besoin de plus d'informations.

Survey : récupérer les réponses de l'app Survey

Pour récupérer les questions auxquelles un employé a répondu, vous pouvez demander à l'API timesreports d'obtenir toutes ses feuilles de temps, puis récupérer les questions auxquelles il a répondu à l'aide de L'API /survey

Pour utiliser L'API de demandes de renseignements(enquiries) vous devez demander  /api/apps/survey/enquiries/timesreport_{id} l'id est construit comme ceci : timesreport_XX XX est l'id de la feuille de temps.

Les limites des requêtes BDD

Certains endpoints API ne sont accessibles qu'à l'aide d'un compte administrateur, c'est-à-dire que vous devrez créer un jeton d'accès pour un manager disposant d'un accès administrateur.

Vous pouvez lire l'intégralité de votre base de données à l'aide de ce point de terminaison. Cependant, il existe des limitations sur les requêtes MySQL qui peuvent être exécutées sur notre base de données :

  • Seules les demandes de lecture sont autorisées.

  • Les requêtes sont également limitées aux champs nommés.

  • La taille de la requête est limitée à 15 000 caractères maximum.

  • Un maximum de 15 instructions JOIN (INNER, LEFT & RIGHT) par requête.

  • Un maximum de 2 requêtes imbriquées par requête

  • Une mention LIMIT est obligatoire à la fin de chaque requête permettant de récupérer un maximum de 300 résultats PAR PAGE.

 

Nous espérons que ce tutoriel vous aura été utile et nous vous invitons à nous le faire savoir en votant dans la section dédiée ci-dessous.

Si vous avez encore d'autres questions, n'hésitez pas à contacter notre équipe Support :

Contactez notre équipe d'assistance

Tel : (+33) 03 62 27 61 05

Boondmanager-Mascot-Desk-lg.png

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 1

Commentaires

0 commentaire

Cet article n'accepte pas de commentaires.