Skip to content

API-adgang

Under Indstillinger → API-adgang giver du et eksternt system adgang til abonnementets fakturaer, og du bestemmer, hvad systemet skal have besked om. Siden er kun tilgængelig for kundeadministratorer og support.

Siden har to faner: API-nøgler og Webhooks.

API-nøgler

En API-nøgle er den adgangskode, det eksterne system sender med hver forespørgsel. Nøglen gælder alle abonnementets selskaber — den er ikke knyttet til en bruger eller et enkelt selskab. Hvad den må bruge i selskaberne, bestemmer du under Adgang.

Opret en nøgle

  1. Vælg Opret API-nøgle.
  2. Giv nøglen et navn, der siger, hvilket system den er til.
  3. Vælg under Adgang, hvad nøglen må bruge. Se nedenfor.
  4. Vælg Gem.

Nøglen vises nu i fuld længde. Kopier den med det samme — den vises kun denne ene gang og kan ikke hentes frem igen. På listen ser du derefter kun dens begyndelse. Er nøglen gået tabt, sletter du den og opretter en ny.

Adgang

For hvert område vælger du Ingen adgang, Læse eller Læse og ændre:

  • Købsfakturaer — læse fakturaerne og deres linjer, og ved Læse og ændre også rette dem.
  • Salgsfakturaer, Udlæg og Bankfiler — kan kun læses.
  • Webhooks — se abonnementets webhooks, og ved Læse og ændre også oprette og slette dem.
  • PMS-opsætning — læse hotelintegrationer, PMS-koder og PMS-dimensioner, og ved Læse og ændre også ændre dem.

En ny nøgle har ingen adgang, før du vælger den. Alle nøgler kan dog altid læse selskaberne og deres konti, dimensioner, momskombinationer og kreditorer, fordi intet andet kan bruges uden dem.

Du kan ændre adgangen når som helst ved at åbne nøglen. Ændringen gælder fra systemets næste forespørgsel. Beder systemet om noget, nøglen ikke har adgang til, får det et afslag, der siger, hvilken adgang der mangler.

Nøgler, der fandtes, før adgangen kunne vælges, har fået adgang til alt det, de kunne bruge før — men ikke til PMS-opsætningen. Den skal vælges på nøglen.

Sæt en integration på pause

Slå Aktiveret fra på nøglen. Systemet, der bruger den, afvises med det samme, præcis som hvis nøglen var ukendt, men rækken bliver stående. Slå den til igen, og integrationen virker som før.

Kolonnen Sidst brugt viser, hvornår nøglen sidst blev anvendt, så en nøgle, ingen længere bruger, er til at få øje på. Tidspunktet opdateres højst hvert femte minut.

Slet en nøgle

Sletning kan ikke fortrydes, og integrationer, der bruger nøglen, holder op med at virke med det samme.

Webhooks

En webhook er en adresse, platformen sender besked til, når noget sker med en faktura. I stedet for at det eksterne system spørger igen og igen, får det besked af sig selv.

Opret en webhook

  1. Vælg Opret webhook.
  2. Giv den et navn.
  3. Skriv Slutpunktet — den adresse, beskeden sendes til. Adressen skal begynde med https://.
  4. Vælg de hændelser, adressen skal have besked om:
  5. Faktura oprettet — en faktura er kommet ind.
  6. Faktura opdateret — en faktura, der allerede fandtes, er blevet ændret.
  7. Angiv eventuelt en signeringsnøgle. Se nedenfor.
  8. Vælg Gem.

En nyoprettet webhook starter fra oprettelsestidspunktet. Den sender altså besked om det, der sker fremover, og gennemgår ikke de fakturaer, abonnementet allerede har.

En faktura, der kommer ind og bliver ændret kort efter, udløser kun Faktura oprettet.

Signeringsnøglen

Sætter du en signeringsnøgle, sender platformen et aftryk af beskedens indhold med i hver forespørgsel. Modtageren kan regne det samme aftryk ud og derved se, at beskeden kom fra os og ikke er ændret undervejs. Aftrykket ligger i headeren X-2CA-Signature.

Nøglen vises aldrig igen, når den først er gemt. Lad feltet stå tomt for at beholde den, du har, og skriv en ny for at erstatte den.

Seneste leveringer

Åbner du en webhook, viser den nederst de seneste forsøg: tidspunkt, hændelse, hvilken faktura det drejede sig om, og hvad adressen svarede.

  • En grøn statuskode betyder, at beskeden blev modtaget.
  • En rød kode, eller Intet svar, betyder, at den ikke blev det.

Et forsøg, der mislykkes, gentages ikke. Var adressen nede en periode, står de mislykkede forsøg i listen, og de beskeder er ikke sendt igen.

Sæt en webhook på pause

Slå Aktiveret fra. Der sendes intet, mens den er slået fra. Slår du den til igen, fortsætter den fra det sted, den stoppede, og sender det, der er kommet imens.

Slet en webhook

Leveringshistorikken slettes sammen med webhooken.