API-nycklar och webhooks

Med NextSigns API kan era egna system skapa och skicka ärenden, och med webhooks får systemen besked när något händer, till exempel när ett ärende är signerat. Det kräver en API-nyckel och en adress som webhooken kan skicka till.

Videon visar hur du skapar båda. Nedan beskrivs stegen.

Så här gör du

1. Skapa en API-nyckel. Under API-nycklar klickar du på "Skapa" och ger nyckeln ett namn, till exempel namnet på systemet som ska använda den.
2. Spara nyckeln. Nyckeln visas bara en gång. Kopiera den och spara den på ett säkert ställe, till exempel bland ert systems hemligheter.
3. Skapa en webhook. Under Webhooks klickar du på "Skapa". Ge webhooken ett namn, välj händelserna som ska ge besked och ange adressen som meddelandet ska skickas till.
4. Testa webhooken. Välj "Skicka test" i menyn bredvid webhooken, välj en händelse och ett ärende och skicka testet. Du ser direkt om meddelandet levererades.

Bra att veta

• Skapa en nyckel per system, så kan du ta bort en nyckel utan att påverka de andra.
• Under Se körningar ser du de senaste meddelandena som webhooken har skickat och om de levererades.
• Behöver ert system känna till avsändaren finns NextSigns IP-adress för allowlisting på sidan Webhooks.

Frågor och svar

Vad gör jag om en nyckel har delats av misstag?

Ta bort nyckeln under API-nycklar och skapa en ny. Den gamla slutar fungera.

Vilka händelser kan en webhook ge besked om?

Bland annat när ett ärende skapas, när en mottagare har signerat, när alla har signerat, när ett ärende avvisas och när en leverans har misslyckats.

Var hittar jag dokumentationen för API:et?

Under API-dokumentation i menyn längst ned till vänster.