API-nøgler og webhooks

Med NextSigns API kan jeres egne systemer oprette og sende sager, og med webhooks får systemerne besked, når der sker noget, for eksempel når en sag er underskrevet. Det kræver en API-nøgle og en adresse, webhooken kan sende til.

Videoen viser, hvordan du opretter begge dele. Herunder er fremgangsmåden beskrevet.

Sådan gør du

1. Opret en API-nøgle. Under API-nøgler klikker du på "Opret" og giver nøglen et navn, for eksempel navnet på det system, der skal bruge den.
2. Gem nøglen. Nøglen vises kun én gang. Kopiér den, og gem den et sikkert sted, for eksempel i jeres systems hemmeligheder.
3. Opret en webhook. Under Webhooks klikker du på "Opret". Giv webhooken et navn, vælg de hændelser, der skal give besked, og angiv den adresse, beskeden skal sendes til.
4. Test webhooken. Vælg "Send test" i menuen ud for webhooken, vælg en hændelse og en sag, og send testen. Du ser med det samme, om beskeden blev leveret.

Godt at vide

• Lav en nøgle pr. system, så du kan slette én nøgle uden at påvirke de andre.
• Under Se kørsler kan du se de seneste beskeder, webhooken har sendt, og om de blev leveret.
• Kræver jeres system, at afsenderen er kendt, finder du NextSigns IP-adresse til allowlisting på siden Webhooks.

Spørgsmål og svar

Hvad gør jeg, hvis en nøgle er blevet delt ved en fejl?

Slet nøglen under API-nøgler, og opret en ny. Den gamle virker ikke længere.

Hvilke hændelser kan en webhook give besked om?

Blandt andet når en sag er oprettet, når en modtager har skrevet under, når en sag er underskrevet af alle, når en sag er afvist, og når en levering er fejlet.

Hvor finder jeg dokumentationen til API'et?

Under API-dokumentation i menuen nederst til venstre.