Automiser la saisie de données pour les KPI avec l'API RESTful

Lecture et écriture automatiques de données pour les KPI avec l'API RESTful. Automatisez l'accès à vos données pour les outils commerciaux de tiers.

Informations générales

  • Documentation. La documentation pour les appels API est disponible ici.
  • Point de rappels. Les alertes dans BSC Designer peuvent être configurées pour envoyer des point de rappels.
  • Limitations. Un compte a une limite de 100 appels API par heure et par utilisateur puissant.

Démarrage

Trouvez ci-dessous quelques instructions qui vous aideront à démarrer.

Clé d'autorisation

Les appels API nécessiteront une clé API ou une clé d'autorisation temporaire.

Pour créer une nouvelle clé API, suivez les étapes suivantes:

  1. Aller à la section Réglages>
  2. Changer vers le tab d’Intégrations
  3. Cliquez sur le Ajouter une clé API bouton

Utiliser le paramètre Clé API obtenu dans les en-têtes de tous les autres appels à l'API:

POST /rest/login HTTP/1.1

Hôte : https://www.webbsc.com

Type de contenu : application/json

Token: replace_with_obtained_token

Attention des ID pour la fiche d’évaluation et les KPI

Les appels à l'API liés au KPI nécessitent l'identification de la fiche d’évaluation et le GUID du KPI.

Obtenir l'ID de la fiche d’évaluation

L’ID de la fiche d’évaluation peut être trouvé en utilisant API call ou manuellement. Pour trouver l'ID de la fiche d’évaluation manuellement:

  1. Voir la Mes fiches de résultats section
  2. Ouvrir la fiche d’évaluation cible
  3. L'URL de la fiche d’évaluation sera quelque chose comme ceci : https://www.webbsc.com/s/123456
  4. Le numéro à la fin est l'ID de la fiche d’évaluation

Obtenir un guide pour les KPI

Le GUIDE DES KPI peut être trouvé en utilisant API call ou manuellement. Pour trouver le GUIDE manuellement:

  1. Ouverture de la fiche d’évaluation
  2. Sélectionner Outils > Exporter les valeurs des indicateurs
  3. Suivre les étapes pour arriver à la page de Prévisualisation des résultats d'exportation
  4. GUIDE la colonne dans le tableau de prévisualisation contiendra le GUIDE des KPI

Valeur d'écriture et de lecture à l'aide de l'API

Utiliser le Contrôleur de valeur des KPI pour écrire et lire les données pour les KPI.

  • Souvenez-vous d'utiliser la clé dans l'en-tête des demandes
  • Les dates doivent être au format aaaa-MM-jj (par exemple "2017-06-30")
  • Les données sont envoyées et reçues au format JSON
  • Pour optimiser les numéros d'appel, utilisez les appels par groupes
  • Pour lire des valeurs groupées, calculées ou héritées, utilisez le Contrôleur de valeurs groupées
    • .

Vérifiez l'exemple php d'utilisation de l'API.