Spring videre til hovedindholdet

Udviklerapps, API-nøgler og webhooks

Opret apps og API-nøgler, test i en sandbox, send webhooks, installér andre virksomheders apps, og se anmodningslogfiler og forbrug pr. nøgle.

Skrevet af Sarah Chen

Indstillingerne under Udvikler er stedet, hvor du forbinder Exayard med din egen kode og med apps, som andre virksomheder bygger. Åbn Indstillinger og derefter Udvikler. Kun virksomhedens administratorer ser siden i menuen Indstillinger. Et medlem, der åbner siden, kan læse den, men ikke ændre noget.

Apps, API-nøgler, webhooks og logfiler følger med alle abonnementer, også Free. Kun AI-arbejde koster penge.

Apps

En app er en af dine integrationer, f.eks. "Acme estimator" eller "Natlig synkronisering". Hver API-nøgle hører til en app. Apps er den første sektion på siden. Alle medlemmer kan læse den. Kun administratorer opretter eller ændrer apps.

Klik på Ny app, og udfyld dens Navn, Beskrivelse, Hjemmeside, Support-e-mail og Tilladelser. Tilladelserne er opdelt i læse- og skriveadgang pr. ressource, f.eks. read:projects og write:estimates. Apps kan ikke bede om tilladelsen admin:org. En virksomhed kan have op til 25 apps.

Hver app viser, hvornår den blev oprettet, og dens anmodningsgrænse, f.eks. "Op til 60 anmodninger i minuttet pr. virksomhed og 600 i alt". Appens menu Flere handlinger indeholder:

  • Rediger ændrer appens oplysninger og tilladelser.

  • Webhook angiver den ene adresse, der modtager hændelser fra alle virksomheder, der har installeret appen.

  • Slet app fjerner appen og tilbagekalder alle dens nøgler. Alle virksomheder, der har installeret den, mister adgangen.

API-nøgler

En API-nøgle lader din egen kode kalde Exayard API'et. Nøgler findes inde i en app under Nøgler. En nøgle virker i sin apps egen virksomhed, så du skal ikke angive et virksomheds-ID.

For at oprette en skal du klikke på Ny nøgle i appen. Giv nøglen et Navn, f.eks. "Produktion". Under Tilladelser vælger du Alle for at få alle de tilladelser, appen har, eller Specifikke for at vælge færre. Angiv eventuelt en dato under Udløber, hvis nøglen er til kortvarigt arbejde. Nøglen virker til og med den dag. Klik på Opret.

Exayard viser hele nøglen én gang. Kopiér den med det samme, for den vises aldrig igen. Exayard gemmer kun en krypteret kopi, så en mistet nøgle kan ikke gendannes. Opret en ny, og tilbagekald den gamle.

En nøgle starter med exa_live_. En nøgle, der er oprettet i en sandbox, starter med exa_test_. Når du har oprettet den, viser nøglen sit navn, en forhåndsvisning som exa_live_...AbCd og Sidst brugt eller Aldrig brugt. En nøgle med en udløbsdato viser Udløber og datoen, og en udløbet nøgle viser Udløbet.

En app kan have op til 25 aktive nøgler. En udløbet nøgle tæller stadig med, indtil du tilbagekalder den. For at skifte nøgler uden afbrydelse skal du oprette en ekstra nøgle, flytte dine servere over på den og derefter tilbagekalde den første.

Åbn en nøgles menu Handlinger for nøgle for at Omdøb den eller Tilbagekald den. Tilbagekaldelse kan ikke fortrydes, og nøglen holder op med at virke inden for 30 sekunder.

Hvis en nøgle dukker op et offentligt sted, f.eks. i et offentligt koderepository, tilbagekalder Exayard den, sender en e-mail til din virksomheds administratorer og beholder den på listen markeret med Fundet offentligt, tilbagekaldt.

Når en anden virksomhed har installeret din app, viser dialogen for en ny nøgle også Virker i. Denne virksomhed er standard. Alle virksomheder, der har installeret den opretter en nøgle, som din server bruger i hver af disse virksomheder. Hvert kald angiver så sin virksomhed i headeren Exayard-Organization-Id.

De samme nøgler forbinder no-code-værktøjerne. Se Forbind Exayard med Zapier, Forbind Exayard med Make og Forbind Exayard med n8n. For AI-assistenter, se Forbind Exa til din AI-assistent.

Ældre nøgler

Nøgler, der blev oprettet, før nøgler hørte til apps, starter med ak_. De virker stadig, men der kan ikke oprettes nye. De vises under Ældre nøgler nederst på siden, men kun så længe der findes nogen.

Alle administratorer ser alle virksomhedens nøgler her, uanset hvem der oprettede dem. En nøgle, som en anden har oprettet, viser Oprettet af og personens navn. Hver person ser også sine egne personlige nøgler. Klik på skraldespandsikonet for at Tilbagekald en nøgle. Den holder straks op med at virke.

Sandboxe

En sandbox er en testvirksomhed, der er knyttet til din. Brug den til at bygge og teste en integration uden at røre dine rigtige projekter. Kun administratorer ser Sandboxe.

Klik på Ny sandbox, giv den et Navn, og klik på Opret. En virksomhed kan have op til 5 sandboxe. Åbn skifter dig over i sandboxen, hvor virksomhedsvælgeren markerer den med Sandbox. Opret en app og en nøgle der som normalt. Dens nøgler starter med exa_test_. For at gå live skal du oprette den samme app og nøgle i din rigtige virksomhed og udskifte nøglen i din kode.

En sandbox følger din virksomheds abonnement, og din virksomhed betaler for dens forbrug. Den har ingen egen fakturering og får ikke sit eget månedlige AI-forbrug. Webhooks og integrationer virker, som de gør i din rigtige virksomhed.

En sandbox sender ikke e-mails med delte tilbud eller underskrevne kopier til personer uden for den, og den sender ingen sms'er. De vises som "Ikke sendt, fordi denne virksomhed er en sandbox". Invitationer til at deltage i sandboxen sendes som normalt.

Opmålinger og fillæsninger i en sandbox returnerer gratis resultater, der er kopieret fra vores eksempelprojekt. Opmålingen, dens sider og den webhook, der sendes, når opmålingen er færdig, er markeret som eksempler. Kalkulationer, tilbud, elementsøgning og chat svarer også gratis med eksempler.

For at fjerne en sandbox skal du klikke på Slet i dens række og derefter på Slet sandbox. Sandboxen lukkes, dens nøgler holder op med at virke, og dens data slettes senere.

Webhooks

En webhook beder Exayard om at give din server besked, når der sker noget i din virksomhed. Alle medlemmer kan læse listen. Kun administratorer tilføjer eller ændrer webhooks.

Klik på Opret webhook, angiv den URL, der skal modtage leverancerne, og tilføj eventuelt en Beskrivelse. Vælg, hvilke Hændelser der skal sendes. Vælg Alle for at modtage alle hændelser, også nye, eller Specifikke for at vælge fra listen. Alle hændelser og deres indhold er beskrevet i kataloget over webhook-hændelser.

Når du opretter en webhook, viser Exayard dens Signeringshemmelighed én gang. Kopiér den med det samme, for den vises ikke igen.

Åbn en webhooks menu Flere handlinger for resten:

  • Rediger ændrer URL, beskrivelse og hændelser og sætter dens Status til Aktiv eller Sat på pause. En webhook, der er sat på pause, modtager ingen leverancer. Dialogen har også Forny hemmelighed. Den gamle hemmelighed holder straks op med at virke, så opdater din server først.

  • Send testhændelse sender én hændelse af den Hændelsestype, du vælger. Dialogen venter på svar fra din server og viser resultatet og svarkoden. En testhændelse indeholder "test": true.

  • Leveringer viser de seneste 25 leverancer med deres hændelse, status, svarkode og antal forsøg. En leverance er Afventer, Prøver igen, Leveret eller Mislykket. Administratorer kan klikke på Send igen for at sende en leverance igen.

  • Slet webhook stopper alle leverancer til den URL.

En testhændelse og en gensendelse sendes én gang og forsøges aldrig igen.

Sikring af webhook-leverancer

Hver leverance indeholder en Exayard-Signature-header i formatet t=<unix>,v1=<digest>. Exayard danner signaturen ved at sammensætte tidsstemplet og anmodningens body og derefter signere dem med HMAC-SHA256 ved hjælp af din webhooks hemmelighed.

Hver leverance indeholder også headerne Exayard-Event-Id, Exayard-Event-Type og Exayard-Organization-Id. JSON-bodyen har et organizationId-felt, der angiver den virksomhed, hændelsen kommer fra. Headeren indeholder det samme id, så du kan videresende en leverance, før du læser bodyen. Signaturen dækker hele bodyen, inklusive organizationId.

Da hver leverance angiver sin virksomhed, kan én modtageradresse betjene mange virksomheder. Registrer den samme URL i hver virksomhed, og videresend hver leverance ud fra organizationId. Hver webhook har sin egen hemmelighed, så vælg hemmeligheden ud fra Exayard-Organization-Id, før du verificerer.

For at verificere en leverance skal du genberegne signaturen med din hemmelighed, bekræfte, at tidsstemplet ligger inden for fem minutter fra nu, og sammenligne digest-værdierne.

En mislykket leverance forsøges op til 10 gange i alt over cirka 80 timer med længere ventetid mellem forsøgene. Hvert forsøg sender den samme body og det samme hændelses-ID. En omdirigering tæller som en fejl.

Lad andre virksomheder installere din app

Din app virker i din egen virksomhed, så snart du opretter den. Hver app har også en del, der hedder Lad andre virksomheder installere denne app. Den viser, om appen er Gennemgået, Gennemgang anmodet eller Ikke gennemgået, dens Login-adresser, dens Klient-ID, og hvor mange virksomheder der kan installere den.

Administratorer åbner menuen Installationshandlinger for følgende:

  • Rediger login-adresser angiver de adresser, Exayard sender folk tilbage til, når din app logger dem ind med deres Exayard-konto. Angiv én adresse pr. linje, op til 10. Hver adresse skal starte med https://, eller http://localhost, mens du tester. Første gang du gemmer login-adresser, viser Exayard appens Klienthemmelighed én gang.

  • Kopiér installationslink kopierer et link, du kan sende til enhver virksomhed. Det åbner installationsdialogen for den virksomheds administrator.

  • Anmod om gennemgang sender appen til Exayard-support til gennemgang.

En ny app kan installeres i op til 25 virksomheder ud over din egen, og den vises ikke i Find apps. Virksomheder under Konti til dine kunder tæller ikke med i den grænse. Når appen er godkendt, viser den Gennemgået, og installationsgrænsen ophæves. Brug Vis i Find apps til at vise den i alle virksomheders oversigt, eller Skjul fra Find apps til at fjerne den igen. En app, der er Suspenderet, kan ikke kalde Exayard, før support ophæver suspenderingen, og dens installationer bevares.

Når du fjerner tilladelser fra en app, mister alle installationer dem straks. Når du tilføjer tilladelser, beholder hver virksomhed sin nuværende adgang, indtil en af dens administratorer godkender de nye tilladelser.

Appens webhook

Åbn appens menu Flere handlinger, og klik på Webhook. Angiv URL, klik på Opret, og kopiér derefter Signeringshemmelighed, som Exayard kun viser én gang. Hver virksomhed, der har installeret appen, sender de hændelser, som de tildelte tilladelser dækker. Din app modtager også app.installed, app.scopes_approved og app.uninstalled, når en virksomhed installerer den, godkender bredere adgang eller fjerner den. Leverancerne angiver deres virksomhed og er signeret på samme måde som andre webhooks.

I den samme dialog kan du Sæt på pause og Genoptag leverancerne, Forny hemmelighed og Slet webhook.

Forbundne apps

Forbundne apps viser de apps, der er installeret i din virksomhed. Alle medlemmer kan se listen. Kun administratorer installerer, fjerner eller godkender.

Hver række viser appens navn, om den er Gennemgået, virksomheden, der har bygget den, hvem der installerede den og hvornår, samt de tilladelser, den har fået.

Installation af en app

Åbn appens installationslink, eller klik på Installér ud for den i Find apps. Dialogen viser, hvem der har bygget appen, om den er gennemgået, og hvilke tilladelser den beder om. Vælg derefter:

  • Virksomhed: enhver virksomhed, hvor du er administrator. En virksomhed, der allerede har appen, er markeret med (installeret). Hvis du installerer igen, gemmes dine nye valg.

  • Projekter: Alle projekter, eller Kun disse projekter, hvor du sætter flueben ved dem, appen må nå, op til 500. Appen kan ikke nå andre projekter i virksomheden.

  • Månedlig AI-grænse: det højeste beløb, appens AI-arbejde må koste din virksomhed i hver faktureringsmåned, i din faktureringsvaluta. Lad feltet stå tomt for Ingen grænse.

Klik på Installér. Hvis appen logger dig ind, sender Exayard dig derefter videre, så du kan gøre login i appen færdigt. Hvis du er medlem, men ikke administrator, fortæller dialogen dig, hvilken virksomheds administrator der kan installere den. Klik på Kopiér link for at sende det til vedkommende.

For at ændre projekterne senere skal du åbne installationslinket igen og installere med det nye valg.

Godkendelse af mere adgang

Når en app beder om flere tilladelser, viser dens række Beder om mere adgang med de nye tilladelser. En administrator klikker på Godkend for at tildele dem. Indtil da beholder appen den adgang, den havde.

Fjernelse af en app

Åbn appens menu Flere handlinger, klik på Fjern, og bekræft. Appen mister straks adgangen til din virksomhed, og dens webhooks stopper. AI-arbejde, som den allerede har startet, bliver stadig gjort færdigt.

Find apps

Find apps vises inde i Forbundne apps. Her vises gennemgåede apps, som deres udviklere har valgt at vise. En app, som din virksomhed allerede har, viser Installeret. Klik på Installér ved en anden app for at åbne installationsdialogen.

Dine personlige forbindelser

Dine personlige forbindelser viser de AI-værktøjer og andre apps, du har forbundet med din egen Exayard-konto, f.eks. ChatGPT eller Claude. Listen vises øverst i Forbundne apps, og kun du ser dine egne. En personlig forbindelse handler som dig, så den kan nå alt det, du kan.

Hver forbindelse viser, hvornår den første og seneste gang blev brugt, og hvilke virksomheder den er brugt i. For at stoppe en forbindelse skal du åbne dens menu Flere handlinger, klikke på Fjern og bekræfte. Dens næste kald afvises. Forbindelsen bliver stående på listen markeret som Fjernet, og Tillad igen giver den adgang igen. For at forbinde et nyt værktøj, se Forbind Exa til din AI-assistent.

Konti til dine kunder

Din app kan oprette Exayard-virksomheder via API'et til kunder, der kun bruger Exayard gennem dit produkt. Din virksomhed ejer disse virksomheder og betaler for det AI-arbejde, der udføres i dem. De har ingen egne medlemmer, og dine apps installeres automatisk i dem.

Konti til dine kunder viser dem for administratorer med hver virksomheds Navn og datoen, hvor den blev Oprettet. Klik på Opgiv, og bekræft for at lukke en. Alle apps i den mister adgangen.

Kom godt i gang

Kortet Kom hurtigt i gang indeholder en færdig prompt til en AI-editor som Claude eller Cursor. Klik på Kopiér prompt, og indsæt den i din editor. Prompten indeholder API'ets basis-URL, godkendelsesformatet, tilladelserne og signeringsmetoden for webhooks, så AI'en kan opbygge en fungerende integration og spørge dig om de oplysninger, den har brug for. Kun administratorer ser dette kort, fordi det kræver en API-nøgle.

Kortet Dokumentation linker til den fulde udviklerdokumentation med Åbn dokumentation og til OpenAPI-specifikation, som beskriver alle ruter og skemaer. Administratorer ser også Forbind til Claude eller Cursor, som åbner opsætningen til at forbinde AI-assistenter med Exayard.

Logfiler

Logfiler viser de anmodninger, der er foretaget til API'et, med de nyeste først. Hver række viser Metode, Sti, Status, Tidspunkt og Latenstid. Klik på Indlæs flere nederst for at se ældre anmodninger.

Administratorer ser alle anmodninger. Medlemmer ser kun de anmodninger, der ikke kom gennem en app.

Administratorer kan filtrere efter App og derefter efter en af appens nøgler. Alle kan skrive en Slutbruger for kun at se den kundes anmodninger. En slutbruger er dit eget ID for en af dine kunder. Din kode sender det med hver anmodning i headeren Exayard-End-User. Brug aldrig en e-mailadresse som ID.

Vælg en række for at se alle detaljer, herunder Anmodnings-ID, appen og slutbrugeren samt Anmodningens indhold og Svarets indhold. Brug logfilerne til at bekræfte, at et kald lykkedes, eller til at finde ud af, hvorfor en integration fejler.

Forbrug pr. nøgle og slutbruger

Administratorer ser, hvad hver app har brugt denne måned, under Forbrug pr. app i Indstillinger og derefter Forbrug. Dine egne apps vises også her. Under hver app viser Efter nøgle, hvad hver nøgle har brugt, og Største slutbrugere viser de fem slutbrugere, der har brugt mest. Forbrug, der ikke er knyttet til en af appens nøgler, vises som Andet.

Månedlig AI-grænse

En apps månedlige AI-grænse er det højeste beløb, dens AI-arbejde må koste din virksomhed i hver faktureringsmåned. For at angive den skal du åbne appens menu Flere handlinger under Forbrug pr. app og klikke på Angiv månedlig AI-grænse. Angiv et beløb i din faktureringsvaluta, og klik på Gem. Gem et tomt felt for at fjerne grænsen.

Når appen når sin grænse, afvises dens AI-arbejde resten af faktureringsmåneden, selv om din virksomhed stadig har AI-forbrug tilbage. Din virksomheds egne grænser gælder stadig. AI-arbejde, som personer selv starter, tæller aldrig med i en apps grænse.

Besvarede dette dit spørgsmål?