Aller au contenu principal

IDs REST et IDs GraphQL

Legalesign dispose de deux API — REST et GraphQL — et chacune utilise un format d’ID différent. L’identifiant sous-jacent est le même dans les deux cas ; seul le format diffère, ce qui permet de les convertir l’un en l’autre. Les deux interfaces web reflètent cela directement.

Quelle interface utilise quel ID​

InterfaceSous-domaineFormat d’ID
Console héritéeapp1.legalesign.comUUIDs REST
Console actuelleconsole.legalesign.comIDs GraphQL (encodés en base64)

Si vous travaillez avec l’API REST, utilisez les IDs visibles dans app1. Si vous travaillez avec l’API GraphQL, utilisez les IDs visibles dans console.

IDs REST​

Les IDs REST sont des UUIDs simples, par exemple :

e6b23ca1-8443-416d-8319-c80a0afa2002

IDs GraphQL​

Les IDs GraphQL sont des chaînes encodées en base64 construites à partir d’un préfixe d’objet de 3 caractères et de l’UUID sous-jacent :

doc + e6b23ca1-8443-416d-8319-c80a0afa2002  →  base64  →  ZG9jZTZiMjNjYTEtODQ0My00MTZkLTgzMTktYzgwYTBhZmEyMDAy

Préfixes courants :

ObjetPréfixe
Documentdoc
Groupegrp
Destinatairerec
Modèletpl
Rôlerol

Conversion entre formats​

UUID REST → ID GraphQL​

Préfixez l’UUID avec le préfixe d’objet puis encodez le résultat en base64 :

Node.js / browser
btoa("doc" + "e6b23ca1-8443-416d-8319-c80a0afa2002")
// "ZG9jZTZiMjNjYTEtODQ0My00MTZkLTgzMTktYzgwYTBhZmEyMDAy"

ID GraphQL → UUID REST​

Décodez la chaîne base64 et retirez les 3 premiers caractères :

Node.js / browser
atob("ZG9jZTZiMjNjYTEtODQ0My00MTZkLTgzMTktYzgwYTBhZmEyMDAy")
// "doce6b23ca1-8443-416d-8319-c80a0afa2002"
// strip "doc" → "e6b23ca1-8443-416d-8319-c80a0afa2002"

Export This Article

Save a copy of this page as PDF or plain text.