Bonnes pratiques et recommandations

Structurer ses requêtes

Demandez uniquement les champs dont vous avez besoin pour votre écran ou votre export : cela réduit le volume de données et améliore les performances. Pour les listes, utilisez les arguments de pagination (page, pageSize) proposés par l’API pour limiter le nombre de résultats par requête.

Exemple : récupérer une liste de biens avec seulement quelques champs :

query {
  businessUnits(page: 1, pageSize: 10) {
    id
    description
    createdDate
  }
}

Erreurs et pagination

Les erreurs GraphQL sont renvoyées dans le tableau errors de la réponse (même avec un HTTP 200). Utilisez les messages et les extensions (codes, champs concernés) pour adapter votre logique. Côté pagination, respectez les curseurs ou offsets indiqués dans le schéma et prévoyez les réponses vides ou partielles.

Exemple de réponse avec erreur :

Response

{
"data": null,
"errors": [
  {
    "message": "Validation failed",
    "extensions": { "code": "VALIDATION_ERROR" }
  }
]
}

Limites et quotas

Respectez les limites de débit (rate limiting) et les quotas éventuels. En cas de dépassement, l'API peut renvoyer une erreur (par ex. type 429) ou un code dans errors.extensions ; adaptez alors la fréquence ou le volume de vos appels.

Selon l'infrastructure, mutualisée ou privée des quotas différents s'appliquent. Nous vous recommandons d'être prudent.

En cours de construction

Cette section sera complétée plus tard avec les limites de débit, quotas et bonnes pratiques associées.