Aller au contenu principal

Connexions d'exportation - OData API

JustPerform expose ses données par le biais d'une API OData standardisée, ce qui permet aux systèmes externes d'utiliser les données de planification et de consolidation. Cela permet une intégration transparente avec les outils de BI, les applications personnalisées et les autres systèmes de l'entreprise.

v25.12:  Vous pouvez exposer les snippets OData via les services OData en référençant leur ID technique, et exporter le rapport via l'API. Pour savoir comment créer des snippets OData, voir Snippets OData.

Activation de l'exportation des données OData

  1. Activer le service OData

    1. Naviguer vers l'administration du système

    2. Sélectionner la configuration de l'API

    3. Activer le service OData

    4. Configurer l'URL du point de terminaison du service

  2. 2. Définir les entités exposées

    1. Sélectionner les modèles de données à exposer

    2. Choisir des tables/vues spécifiques

    3. Définir les autorisations au niveau du champ

    4. Configurer les relations

  3. Définir les autorisations d'accès

    1. Définir les autorisations de lecture et d'écriture

    2. Configurer la sécurité au niveau de l'entité

    3. Définir des règles de sécurité au niveau des lignes

    4. Activer les restrictions d'interrogation

Configuration de l'API

Points de terminaison des services

  • Service Endpoint: https://<API-justperform-instance>/justperform/Workspace/odata/$metadata

  • URL des métadonnées: https://<API-justperform-instance>/odata/SheetNames

Méthodes d'authentification

Authentification par clé API

  1. Générer des clés API par consommateur

  2. Définir des politiques d'expiration

  3. Contrôle de l'utilisation par clé

OAuth 2.0

  1. Configurer le fournisseur OAuth

  2. Mise en place d'applications clients

  3. Définir les champs d'application et les autorisations

Intégration SSO

  1. Exploiter le SSO existant

  2. Établir les permissions des utilisateurs

  3. Accès par session

Meilleures pratiques pour les consommateurs

Paramètre

Meilleures pratiques pour les consommateurs

Recherche efficace

  • Utiliser $select pour limiter les champs

  • Appliquer les filtres appropriés

  • Mise en place de la pagination

  • Mise en cache des données fréquemment consultées

Gestion des erreurs

  • Traiter les réponses aux limites de taux

  • Mettre en œuvre une logique de réessai

  • Enregistrer les demandes qui n'ont pas abouti

  • Contrôler les schémas d'erreur

Optimisation des performances

  • Utiliser les opérations par lots

  • Minimiser les allers-retours

  • Compression des demandes/réponses

  • Mise en place d'un pool de connexions

Cet article vous a-t-il été utile ?

We're sorry to hear that.