Nom de la connexion

Explication

Certains modules ont besoin de s’authentifier pour se connecter avec Make. Il est demandé lors de l’authentification de donner un nom à cette connexion.

Voici comment cela est géré sur PredictFlow.

Convention de nommage

Convention de nommage

state_app_connected-website/client_connexion_version
dev_webflow_uncodeschoolcom_connexion
prod_tally_acme_connexion
dev_stripe_acmecom_connexion_v1.0

Details

Voici le tableau explicatif.

NAMING	DESCRIPTION	EXEMPLES
STATE	Par défaut, c’est la connexion de prod que vous allez utiliser bien souvent. Toutefois, il se pourrait que sur certaines applications vous ayez la possibilité de vous connecter avec une connexion de dev.	dev prod
APP	Nom de l’application qui est utilisée (souvent le nom du module)	webflow tally folk
CONNECTED-WEBSITE/CLIENT	Nom de l’application connectée à cette application (soit le nom de l’application, soit le nom du site web)	googledrive johncrewcom
CONNEXION	Terme à utiliser pour décrire la connexion entre les 2 applications.	connexion
VERSION	Correspond à la version de l’API utilisée. Cette information est optionnelle. Si aucune information n’est donnée sur la version de l’API, ne pas mettre l’information, si elle est présente dans la documentation alors mettre la version.	v1 v1.0 v2.3 v2023-10-16

Consédérations générales

• Le naming est en minuscule
• Séparation des noms d’application / site web sont avec un underscore

Example

Connexion en Prod (non versionné)

Connexion en Dev (non versionné)

Connexion API versionnée

FAQ

Comment gérer le versioning ?

Objectif du nommage D’utiliser 1 ou plusieurs versions des API via les connexions. Cela va permettre également à toutes les personnes qui travailleront sur le projet de savoir quelle est la version de l’API sur laquelle vous travaillez afin de pouvoir faire des modifications par la suite. Si vous souhaitez mettre à jour la connexion API avec de nouvelles clés par exemple, vous pourrez incrémenter les versions.

Comment faire ? Consulter la documentation de l’API de savoir la version que vous utilisez. Le nommage va dépendre du nommage utilisé par la documentation API. Le mieux est de taper dans Google “[nom de l’outil] api version” pour trouver le bon nommage de la version. Bien souvent cela ressemble à cela :

• Soit v1, v2
• Soit v1.0.0, v2.0.0
• Soit v2022-12-05