Zum Hauptinhalt springen

REST-IDs und GraphQL-IDs

Legalesign hat zwei APIs — REST und GraphQL — und jede verwendet ein anderes ID-Format. Der zugrunde liegende Bezeichner ist in beiden Fällen derselbe; nur das Format unterscheidet sich, sodass sie ineinander umgewandelt werden können. Die beiden Weboberflächen spiegeln dies direkt wider.

Welche Oberfläche verwendet welche ID​

OberflächeSubdomainID-Format
Alte Konsoleapp1.legalesign.comREST UUIDs
Aktuelle Konsoleconsole.legalesign.comGraphQL IDs (base64-kodiert)

Wenn Sie mit der REST API arbeiten, verwenden Sie die in app1 sichtbaren IDs. Wenn Sie mit der GraphQL API arbeiten, verwenden Sie die in console sichtbaren IDs.

REST IDs​

REST IDs sind einfache UUIDs, zum Beispiel:

e6b23ca1-8443-416d-8319-c80a0afa2002

GraphQL IDs​

GraphQL IDs sind base64-kodierte Zeichenketten, die aus einem 3-stelligen Objektpräfix und der zugrunde liegenden UUID zusammengesetzt sind:

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

Übliche Präfixe:

ObjektPräfix
Dokumentdoc
Gruppegrp
Empfängerrec
Vorlagetpl
Rollerol

Umwandlung zwischen Formaten​

REST UUID → GraphQL ID​

Fügen Sie dem UUID das Objektpräfix voran und kodieren Sie das Ergebnis base64:

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

GraphQL ID → REST UUID​

Dekodieren Sie die base64-Zeichenkette und entfernen Sie die ersten 3 Zeichen:

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.