API-nøkler og webhooks

Med NextSigns API kan deres egne systemer opprette og sende saker, og med webhooks får systemene beskjed når noe skjer, for eksempel når en sak er signert. Det krever en API-nøkkel og en adresse webhooken kan sende til.

Videoen viser hvordan du oppretter begge deler. Nedenfor er fremgangsmåten beskrevet.

Slik gjør du

1. Opprett en API-nøkkel. Under API-nøkler klikker du på «Opprett» og gir nøkkelen et navn, for eksempel navnet på systemet som skal bruke den.
2. Lagre nøkkelen. Nøkkelen vises bare én gang. Kopier den, og lagre den på et trygt sted, for eksempel blant systemets hemmeligheter.
3. Opprett en webhook. Under Webhooks klikker du på «Opprett». Gi webhooken et navn, velg hendelsene som skal gi beskjed, og oppgi adressen beskjeden skal sendes til.
4. Test webhooken. Velg «Send test» i menyen ved siden av webhooken, velg en hendelse og en sak, og send testen. Du ser med en gang om beskjeden ble levert.

Greit å vite

• Lag én nøkkel per system, så kan du slette én nøkkel uten å påvirke de andre.
• Under Se kjøringer ser du de siste beskjedene webhooken har sendt, og om de ble levert.
• Krever systemet deres at avsenderen er kjent, finner du NextSigns IP-adresse for tillatelseslisten på siden Webhooks.

Spørsmål og svar

Hva gjør jeg hvis en nøkkel er delt ved en feil?

Slett nøkkelen under API-nøkler, og opprett en ny. Den gamle slutter å virke.

Hvilke hendelser kan en webhook gi beskjed om?

Blant annet når en sak er opprettet, når en mottaker har signert, når alle har signert, når en sak er avvist, og når en levering har feilet.

Hvor finner jeg dokumentasjonen for API-et?

Under API-dokumentasjon i menyen nederst til venstre.