Hoppa till huvudinnehåll

Utvecklarappar, API-nycklar och webhooks

Skapa appar och API-nycklar, testa i en sandlåda, skicka webhooks, installera andra företags appar och läs förfrågningsloggar och kostnader per nyckel.

Skrivet av Sarah Chen

I inställningarna för Utvecklare kopplar du Exayard till din egen kod och till appar som andra företag bygger. Öppna Inställningar och sedan Utvecklare. Endast företagets administratörer ser den i menyn Inställningar. En medlem som öppnar sidan kan läsa den men inte ändra något.

Appar, API-nycklar, webhooks och loggar ingår i alla abonnemang, även Free. Endast AI-arbete debiteras.

Appar

En app är en av dina integrationer, till exempel "Acme estimator" eller "Nattlig synk". Varje API-nyckel hör till en app. Appar är det första avsnittet på sidan. Alla medlemmar kan läsa det. Endast administratörer skapar eller ändrar appar.

Klicka på Ny app och fyll i dess Namn, Beskrivning, Webbplats, E-post för support och Behörigheter. Behörigheterna är uppdelade i läsning och skrivning per resurs, till exempel read:projects och write:estimates. Appar kan inte begära behörigheten admin:org. Ett företag kan ha upp till 25 appar.

Varje app visar när den skapades och dess anropsgräns, till exempel "Upp till 60 förfrågningar per minut per företag och 600 totalt". Appens meny Fler åtgärder innehåller:

  • Redigera ändrar appens uppgifter och behörigheter.

  • Webhook anger den enda adress som tar emot händelser från alla företag som har installerat appen.

  • Ta bort app tar bort appen och återkallar alla dess nycklar. Alla företag som har installerat den förlorar åtkomsten.

API-nycklar

Med en API-nyckel kan din egen kod anropa Exayards API. Nycklarna finns i en app, under Nycklar. En nyckel fungerar i appens eget företag, så du behöver inte skicka med något företags-ID.

Skapa en nyckel genom att klicka på Ny nyckel i appen. Ge nyckeln ett Namn, till exempel "Produktion". Under Behörigheter väljer du Alla för att ge alla behörigheter som appen har, eller Specifika för att välja färre. Ange ett valfritt datum under Upphör om nyckeln är avsedd för kortvarigt arbete. Nyckeln fungerar till och med slutet av den dagen. Klicka på Skapa.

Exayard visar hela nyckeln en gång. Kopiera den då, eftersom den aldrig visas igen. Exayard sparar bara en krypterad kopia, så en förlorad nyckel kan inte återställas. Skapa en ny och återkalla den gamla.

En nyckel börjar med exa_live_. En nyckel som skapas i en sandlåda börjar med exa_test_. När du har skapat den visar nyckeln sitt namn, en förhandsvisning som exa_live_...AbCd och Senast använd eller Aldrig använd. En nyckel med slutdatum visar Upphör och datumet, och en nyckel som har gått ut visar Har upphört.

En app kan ha upp till 25 aktiva nycklar. En nyckel som har gått ut räknas fortfarande tills du återkallar den. För att byta nycklar utan avbrott skapar du en andra nyckel, flyttar dina servrar till den och återkallar sedan den första.

Öppna en nyckels meny Nyckelåtgärder för att Byt namn på den eller Återkalla den. Återkallandet kan inte ångras, och nyckeln slutar fungera inom 30 sekunder.

Om en nyckel dyker upp på en offentlig plats, till exempel i ett offentligt kodförråd, återkallar Exayard den, skickar e-post till dina administratörer och behåller den i listan markerad som Hittad offentligt, återkallad.

När ett annat företag har installerat din app visar dialogrutan för ny nyckel även Fungerar i. Det här företaget är standardvalet. Alla företag som har installerat den skapar en nyckel som din server använder i vart och ett av dessa företag. Varje anrop anger då sitt företag i headern Exayard-Organization-Id.

Samma nycklar ansluter även verktygen utan kod. Se Koppla Exayard till Zapier, Koppla Exayard till Make och Koppla Exayard till n8n. För AI-assistenter, se Koppla Exa till din AI-assistent.

Äldre nycklar

Nycklar som skapades innan nycklar fanns i appar börjar med ak_. De fortsätter att fungera, men inga nya kan skapas. De visas under Äldre nycklar längst ner på sidan, men bara så länge det finns några.

Alla administratörer ser där alla företagets nycklar, oavsett vem som skapade dem. En nyckel som någon annan har skapat visar Skapad av och personens namn. Varje person ser också sina egna personliga nycklar. Klicka på papperskorgsikonen för att Återkalla en nyckel. Den slutar fungera omedelbart.

Sandlådor

En sandlåda är ett testföretag som är kopplat till ditt. Använd den för att bygga och testa en integration utan att röra dina riktiga projekt. Endast administratörer ser Sandlådor.

Klicka på Ny sandlåda, ge den ett Namn och klicka på Skapa. Ett företag kan ha upp till 5 sandlådor. Öppna växlar dig till sandlådan, där företagsväljaren markerar den som Sandlåda. Skapa en app och en nyckel där som vanligt. Dess nycklar börjar med exa_test_. För att gå live skapar du samma app och nyckel i ditt riktiga företag och byter ut nyckeln i din kod.

En sandlåda följer ditt företags abonnemang, och ditt företag betalar för dess användning. Den har ingen egen fakturering och får ingen egen månatlig AI-användning. Webhooks och integrationer fungerar som i ditt riktiga företag.

En sandlåda skickar inga e-postmeddelanden om delade anbud eller signerade kopior till personer utanför den, och den skickar inga sms. De visas som "Skickades inte eftersom det här företaget är en sandlåda". Inbjudningar att gå med i sandlådan skickas som vanligt.

Mängdavtagningar och filläsningar i en sandlåda returnerar resultat som är kopierade från vårt exempelprojekt, utan kostnad. Mängdavtagningen, dess sidor och den webhook som skickas när mängdavtagningen är klar markeras som exempel. Kalkyler, anbud, elementsökning och chatt svarar också med exempel, utan kostnad.

För att ta bort en sandlåda klickar du på Ta bort på dess rad och sedan på Ta bort sandlåda. Sandlådan stängs, dess nycklar slutar fungera och dess data raderas senare.

Webhooks

En webhook säger åt Exayard att meddela din server när något händer i ditt företag. Alla medlemmar kan läsa listan. Endast administratörer lägger till eller ändrar webhooks.

Klicka på Skapa webhook, ange den URL som ska ta emot leveranserna och lägg till en valfri Beskrivning. Välj vilka Händelser som ska skickas. Välj Alla för att ta emot alla händelser, även nya, eller Specifika för att välja från listan. Alla händelser och deras innehåll finns i katalogen över webhook-händelser.

När du skapar en webhook visar Exayard dess Signeringshemlighet en gång. Kopiera den då, eftersom den inte visas igen.

Öppna en webhooks meny Fler åtgärder för resten:

  • Redigera ändrar URL, beskrivning och händelser, och ställer in dess Status till Aktiv eller Pausad. En pausad webhook tar inte emot några leveranser. Dialogrutan har även Rotera hemlighet. Den gamla hemligheten slutar fungera omedelbart, så uppdatera din server först.

  • Skicka testhändelse skickar en händelse av den Händelsetyp du väljer. Dialogrutan väntar på din servers svar och visar resultatet och svarskoden. En testhändelse innehåller "test": true.

  • Leveranser listar de senaste 25 leveranserna med deras händelse, status, svarskod och antal försök. En leverans är Väntande, Försöker igen, Levererad eller Misslyckades. Administratörer kan klicka på Skicka igen för att skicka en leverans på nytt.

  • Ta bort webhook stoppar alla leveranser till den URL:en.

En testhändelse och en omsändning skickas en gång och försöks aldrig igen.

Säkra webhook-leveranser

Varje leverans innehåller en Exayard-Signature-header i formatet t=<unix>,v1=<digest>. Exayard skapar signaturen genom att sammanfoga tidsstämpeln och förfrågans brödtext och sedan signera dem med HMAC-SHA256 med hjälp av webhookens hemlighet.

Varje leverans innehåller också headrarna Exayard-Event-Id, Exayard-Event-Type och Exayard-Organization-Id. JSON-brödtexten har ett organizationId-fält som anger vilket företag händelsen kommer från. Headern innehåller samma ID, så att du kan dirigera en leverans innan du läser brödtexten. Signaturen omfattar hela brödtexten, inklusive organizationId.

Eftersom varje leverans anger sitt företag kan en och samma mottagaradress betjäna många företag. Registrera samma URL i varje företag och dirigera varje leverans utifrån organizationId. Varje webhook har sin egen hemlighet, så välj hemlighet utifrån Exayard-Organization-Id innan du verifierar.

För att verifiera en leverans beräknar du signaturen på nytt med din hemlighet, kontrollerar att tidsstämpeln ligger inom fem minuter från nu och jämför sammanfattningsvärdena.

En misslyckad leverans försöks upp till 10 gånger totalt, under ungefär 80 timmar, med allt längre väntetid mellan försöken. Varje försök skickar samma brödtext och samma händelse-ID. En omdirigering räknas som ett misslyckande.

Låt andra företag installera din app

Din app fungerar i ditt eget företag så snart du har skapat den. Varje app har också en del som heter Låt andra företag installera den här appen. Den visar om appen är Granskad, Granskning begärd eller Inte granskad, dess Inloggningsadresser, dess Klient-ID och hur många företag som kan installera den.

Administratörer öppnar menyn Installationsåtgärder för följande:

  • Redigera inloggningsadresser anger de adresser som Exayard skickar tillbaka personer till när din app loggar in dem med deras Exayard-konto. Ange en adress per rad, upp till 10. Varje adress måste börja med https://, eller http://localhost medan du testar. Första gången du sparar inloggningsadresser visar Exayard appens Klienthemlighet en gång.

  • Kopiera installationslänk kopierar en länk som du kan skicka till vilket företag som helst. Den öppnar installationsdialogen för företagets administratör.

  • Begär granskning skickar appen till Exayards support för granskning.

En ny app kan installeras i upp till 25 företag utöver ditt eget, och den visas inte i Hitta appar. Företag under Konton för dina kunder räknas inte mot den gränsen. När appen har godkänts visas Granskad och installationsgränsen tas bort. Använd Visa i Hitta appar för att lista den i alla företags katalog, eller Dölj i Hitta appar för att ta bort den därifrån. En Avstängd app kan inte anropa Exayard förrän supporten häver avstängningen, och dess installationer behålls.

När du tar bort behörigheter från en app förlorar alla installationer dem omedelbart. När du lägger till behörigheter behåller varje företag sin nuvarande åtkomst tills en av dess administratörer godkänner de nya behörigheterna.

Appens webhook

Öppna appens meny Fler åtgärder och klicka på Webhook. Ange URL och klicka på Skapa, och kopiera sedan Signeringshemlighet, som Exayard bara visar en gång. Varje företag som har installerat appen skickar de händelser som dess beviljade behörigheter omfattar. Din app tar också emot app.installed, app.scopes_approved och app.uninstalled när ett företag installerar den, godkänner utökad åtkomst eller tar bort den. Leveranserna anger sitt företag och signeras på samma sätt som andra webhooks.

I samma dialogruta kan du Pausa och Återuppta leveranser, Rotera hemlighet och Ta bort webhook.

Anslutna appar

Anslutna appar listar de appar som är installerade i ditt företag. Alla medlemmar kan se den. Endast administratörer installerar, tar bort eller godkänner.

Varje rad visar appens namn, om den är Granskad, företaget som byggde den, vem som installerade den och när, samt de behörigheter den har beviljats.

Installera en app

Öppna appens installationslänk, eller klicka på Installera bredvid den i Hitta appar. Dialogrutan visar vem som byggde appen, om den är granskad och vilka behörigheter den begär. Välj sedan:

  • Företag: vilket företag som helst där du är administratör. Ett företag som redan har appen markeras med (installerad). Om du installerar igen sparas dina nya val.

  • Projekt: Alla projekt, eller Endast dessa projekt och markera de projekt som appen får nå, upp till 500. Appen kan inte nå något annat projekt i företaget.

  • Månadsgräns för AI: det högsta belopp som appens AI-arbete får kosta ditt företag varje faktureringsmånad, i din faktureringsvaluta. Lämna fältet tomt för Ingen gräns.

Klicka på Installera. Om appen loggar in dig tar Exayard dig sedan vidare för att slutföra inloggningen i appen. Om du är medlem men inte administratör anger dialogrutan vilket företags administratör som kan installera den. Klicka på Kopiera länk för att skicka den till hen.

Om du vill ändra projekten senare öppnar du installationslänken igen och installerar med det nya valet.

Godkänna mer åtkomst

När en app begär fler behörigheter visar dess rad Begär mer åtkomst med de nya behörigheterna. En administratör klickar på Godkänn för att bevilja dem. Fram till dess behåller appen den åtkomst den hade.

Ta bort en app

Öppna appens meny Fler åtgärder, klicka på Ta bort och bekräfta. Appen förlorar omedelbart åtkomsten till ditt företag och dess webhooks stoppas. AI-arbete som den redan har startat slutförs ändå.

Hitta appar

Hitta appar visas inuti Anslutna appar. Där listas granskade appar som deras utvecklare har valt att lista. En app som ditt företag redan har visar Installerad. Klicka på Installera på någon annan app för att öppna installationsdialogen.

Dina personliga anslutningar

Dina personliga anslutningar listar de AI-verktyg och andra appar som du har anslutit till ditt eget Exayard-konto, till exempel ChatGPT eller Claude. Listan visas överst i Anslutna appar, och endast du ser dina egna. En personlig anslutning agerar som du, så den kan nå allt som du kan nå.

Varje anslutning visar när den användes första och senaste gången, och i vilka företag den har använts. Om du vill stoppa en anslutning öppnar du dess meny Fler åtgärder, klickar på Ta bort och bekräftar. Dess nästa anrop nekas. Anslutningen ligger kvar i listan markerad som Borttagen, och Tillåt igen släpper in den igen. Om du vill ansluta ett nytt verktyg, se Koppla Exa till din AI-assistent.

Konton för dina kunder

Din app kan skapa Exayard-företag via API:et för kunder som bara använder Exayard genom din produkt. Ditt företag äger dessa företag och betalar för det AI-arbete som utförs i dem. De har inga egna medlemmar, och dina appar installeras automatiskt i dem.

Konton för dina kunder listar dem för administratörer, med varje företags Namn och datumet då det skapades (Skapad). Klicka på Släpp och bekräfta för att stänga ett företag. Alla appar i det förlorar åtkomsten.

Kom igång

Kortet Snabbstart innehåller en färdig prompt för en AI-redigerare som Claude eller Cursor. Klicka på Kopiera prompt och klistra in den i din redigerare. Prompten innehåller API:ets bas-URL, autentiseringsformatet, behörigheterna och schemat för webhook-signering, så att AI:n kan bygga en fungerande integration och fråga dig om de uppgifter den behöver. Endast administratörer ser det här kortet, eftersom det kräver en API-nyckel.

Kortet Dokumentation länkar till den fullständiga utvecklardokumentationen med Öppna dokumentationen, och till OpenAPI-specifikation, som beskriver alla routes och scheman. Administratörer ser också Anslut till Claude eller Cursor, som öppnar inställningen för att koppla AI-assistenter till Exayard.

Loggar

Loggar visar de förfrågningar som har gjorts till API:et, de senaste först. Varje rad visar Metod, Sökväg, Status, Tid och Latens. Klicka på Läs in fler längst ner för att se äldre förfrågningar.

Administratörer ser alla förfrågningar. Medlemmar ser bara de förfrågningar som inte kom via en app.

Administratörer kan filtrera på App och sedan på en av appens nycklar. Vem som helst kan ange en Slutanvändare för att bara se den kundens förfrågningar. En slutanvändare är ditt eget ID för en av dina kunder. Din kod skickar det med varje förfrågan i headern Exayard-End-User. Använd aldrig en e-postadress som ID.

Välj en rad för att se alla detaljer, inklusive Förfrågans ID, appen och slutanvändaren samt Förfrågans innehåll och Svarets innehåll. Använd loggarna för att bekräfta att ett anrop fungerade eller för att ta reda på varför en integration inte fungerar.

Kostnader per nyckel och slutanvändare

Administratörer ser vad varje app har förbrukat den här månaden under Kostnader per app i Inställningar och sedan Användning. Dina egna appar listas också där. Under varje app visar Per nyckel vad varje nyckel har förbrukat, och Största slutanvändare visar de fem slutanvändare som har förbrukat mest. Kostnader som inte är knutna till någon av appens nycklar visas som Övrigt.

Månadsgräns för AI

En apps månadsgräns för AI är det högsta belopp som dess AI-arbete får kosta ditt företag varje faktureringsmånad. Ange den genom att öppna appens meny Fler åtgärder under Kostnader per app och klicka på Ange månadsgräns för AI. Ange ett belopp i din faktureringsvaluta och klicka på Spara. Spara ett tomt fält för att ta bort gränsen.

När appen når sin gräns nekas dess AI-arbete under resten av faktureringsmånaden, även om ditt företag fortfarande har AI-användning kvar. Ditt företags egna gränser gäller fortfarande. AI-arbete som personer själva startar räknas aldrig mot en apps gräns.

Fick du svar på din fråga?