Fonctionnalités expérimentales

Chargetrip introduit de nouvelles capacités importantes via un programme expérimental structuré. Il vous donne un accès anticipé pour évaluer les fonctionnalités à venir et influencer leur conception avant que les schémas et les contrats ne deviennent permanents.

Types de fonctionnalités expérimentales

• Nouvelles opérations : des requêtes, mutations ou souscriptions entièrement nouvelles.
• Extensions d’opérations existantes : de nouveaux arguments facultatifs ou champs de sortie ajoutés à des opérations stables existantes.

Phases des fonctionnalités expérimentales

Pour connaître les garanties des fonctionnalités stables, consultez le cycle de vie de l’API.

Bonnes pratiques

• Utilisez les fonctionnalités alpha pour l’évaluation en bac à sable, les preuves de concept et les retours. Si vous en déployez une malgré tout, vous ne recevez aucun préavis ni protection de compatibilité lorsqu’elle change.
• Si vous exposez des capacités bêta aux utilisateurs finaux, affichez un badge « bêta » pour qu’ils sachent que la capacité est encore en cours de stabilisation.

Cycle de graduation

1. De l’alpha à la bêta

   Lorsque la fonctionnalité et le schéma atteignent une maturité suffisante, la fonctionnalité passe en bêta. La balise de description passe de [ALPHA] à [BETA], l’accès est activé par défaut pour tous les clients et les changements sont annoncés dans les notes de version.

2. De la bêta à la version stable

   Lorsque la fiabilité et la maturité sont validées auprès de plusieurs clients, la balise de description [BETA] et les avertissements d’exécution sont supprimés et la fonctionnalité passe dans le cycle de vie stable.

Tarification

• Les requêtes vers des opérations marquées comme expérimentales sont gratuites.
• Les requêtes envoyées à des points de terminaison stables qui incluent des arguments d’entrée ou des champs de sortie expérimentaux facultatifs sont facturées conformément à votre offre.

Avertissements programmatiques

Pour tenir votre équipe de développement informée des dépendances expérimentales dans le trafic actif, les réponses de l’API qui utilisent des capacités alpha ou bêta renvoient des métadonnées d’avertissement dans le bloc GraphQL extensions :

{  "data": {    "getTruckRoute": {      "id": "dd07b4d0-6b79-11f0-bf8f-e6b813282ac3",      "status": "done"    }  },  "extensions": {    "warnings": [      {        "code": "ALPHA_FEATURE",        "path": ["getTruckRoute"],        "message": "This feature is currently in ALPHA. Visit https://developers.chargetrip.com/api-reference for more information."      }    ]  }}

{  "data": {    "vehicleMakes": {      "name": "Opel"    }  },  "extensions": {    "warnings": [      {        "code": "BETA_FEATURE",        "path": ["vehicleMakes"],        "message": "This feature is currently in BETA. Visit https://developers.chargetrip.com/api-reference for more information."      }    ]  }}