För utvecklare

‍

‍

Så integrerar du med DealBuilder

Med DealBuilder kan du enkelt integrera dina system med hjälp av API, webhooks eller GET-förfrågningar. Detta gör det möjligt att automatisera arbetsflödet, minska manuellt arbete och säkerställa att data flödar sömlöst mellan DealBuilder och andra affärssystem.

Integrationsguide för API-integration.

DealBuilder erbjuder en integrationsguide för hur du kan integrera DealBuilder i dina egna system. Se guiden här.

🛠️ Tre enkla sätt att integrera:

1. Webhooks – Ta emot data från DealBuilder när specifika händelser inträffar (t.ex. när ett dokument skickas eller signeras).
2. GET-förfrågan till DealBuilder – Skicka data från egna system till DealBuilder genom att förifylla avtal automatiskt.
3. ‍API – Fullständigt API för automatiserat dokumentflöde och produktsynkronisering.
   (Se guide för konfiguration av API-integrationer här).
   ‍

📡 1. Integration via webhooks

Webhooks låter dig automatiskt ta emot data från DealBuilder till ditt system varje gång en definierad händelse inträffar. Det kan till exempel vara när ett dokument skickas, öppnas eller signeras.

Så här sätter du upp en webhook:

1. Gå till Admin > Webhooks i DealBuilder.
2. Klicka på Lägg till webhook.
3. Fyll i följande:
   • Namn: Ge integrationen ett beskrivande namn, t.ex. Från DealBuilder till CRM.
   • URL: Ange endpointen som ska ta emot data.
   • E-post vid fel: Fyll i en e-postadress för aviseringar om något går fel.
   • Händelse: Välj vad som ska trigga webhooken (t.ex. Dokument signerat).

👉 Tips: För att testa webhooken kan du använda en tjänst som webhook.site för att se hur datan struktureras för varje händelse.

Se en separat sida för fullständig dokumentation av DealBuilders webhooks här: https://app.dealbuilder.io/webhookdocs
‍

✅ Testning av webhooks

När webhooken har sparats kan du testa att allt fungerar. Klicka på "Kör test", men observera att det måste finnas data i ditt konto för den händelse du testar.

Exempel:
Om du har satt upp en webhook med händelsen "Dokument slutfört" måste du ha ett signerat dokument i ditt DealBuilder-konto för att kunna köra ett test. Systemet använder automatiskt det senast signerade dokumentet som testdata.

Om ditt konto inte har några relevanta data kan testet inte genomföras.

👉 Tips: Skicka först ut ett dokument för signering och signera det, så att du har något att testa med.

‍

🧩 Tillgängliga händelser för webhooks:

• Dokument skickat – När ett dokument skickas från DealBuilder.
• Dokument öppnat – När mottagaren öppnar dokumentet.
• Dokument signerat – När en enskild signatär signerar. En webhook per signatär.
• Dokument slutfört – När alla nödvändiga signaturer är på plats och den signerade PDF-filen är klar. Alla dokumentdata följer med i en webhook.
• Dokument slutfört (per orderrad) – Skickar en webhook per orderrad när dokumentet är slutfört.
• Signeringsfrist utgången – När signeringsfristen löper ut.
• Signeringsfrist ändrad – När signeringsfristen ändras.
• Dokument skickat för intern godkännande – När dokumentet skickas för intern godkännande.
• Dokument återkallat – När ett dokument återkallas innan det är slutfört.
  ‍

Automatiskt nytt försök vid fel

När webhooks skapas kan du aktivera automatiskt nytt försök vid fel. DealBuilder försöker då igen efter 10 minuter och därefter med gradvis längre intervall, i maximalt 10 dagar.

‍

📥 2. Integration via GET-förfrågan till DealBuilder

Du kan fylla i avtalsmallar automatiskt i DealBuilder genom att skicka en GET-förfrågan till följande endpoint:

https://app.dealbuilder.io/Contract/CreateNewContractExternal

Genom att inkludera information som kund-ID, organisationsnummer, e-postadress och andra data i URL:en kan du förifylla avtal direkt från ditt eget system.

Exempel:

https://app.dealbuilder.io/contract/createnewcontractexternal?email=ole@eposten.com&phonenumber=004741434544&companyname=Eksempelfirma%20AS
&customername=Ole+Hansen&address=Eksempelveien%2032+0101+Oslo&visitaddress
=Eksempelveien%2032+0101+Oslo&orgnumber=321654789&CRMid=4963935370

När användaren öppnar länken väljer personen först dokumentmall. Den valda mallen öppnas därefter med uppgifterna från GET-förfrågan förifyllda. Användaren måste ha tillgång till DealBuilder och vara inloggad.

När avtalet har signerats kan du använda webhooks för att hämta ut kund-ID och annan tillhörande information, så att datan automatiskt skickas tillbaka till ditt system.

‍

📋 Du kan fylla i DealBuilder med följande datapunkter automatiskt:

‍

‍

Du kan skapa egna fält på varje dokumentmall under Admin > Mallar > Välj mall > Anpassade fält.
Fältets ID används direkt som query-parameter i GET-länken. Om du till exempel har ett fält med ID customerID kan värdet skickas in så här:
&customerID=12345
‍
Fälten kan visas i dokumentet eller lagras som dolda metadata som returneras via webhook. De kan också användas som variabler i dokumenttexten, exempelvis {cf_customerID}, som automatiskt ersätts med fältets värde.

‍

‍

Anpassade fält kan placeras på flera ställen i dokumentet, bland annat högst upp i dokumentet (under Företagsnamn, Kontaktperson osv.) eller under orderraderna från produktmodulen. Fälten kan också användas som variabler direkt i dokumenttexten. Om ett fält till exempel har ID ValueOfABC kan det sättas in i texten som {cf_ValueOfABC}. När dokumentet skapas ersätts variabeln automatiskt med värdet som har lagts in i fältet.

Anpassade fält kan också vara dolda. Då kan fältet innehålla ett värde utan att det visas som ett eget fält i dokumentet för mottagaren. Värdet lagras som metadata på dokumentet och kan returneras via webhook.

‍

‍

🚀 Vad betyder detta i praktiken?

Det betyder att ni enkelt kan sätta upp en knapp eller länk till DealBuilder i ert eget system. När användaren klickar på den för att skapa ett nytt avtal eller en offert öppnas DealBuilder färdigifyllt med information om motparten (t.ex. kunden) och eventuella anpassade fält som kund-ID:n eller specifika projektdetaljer.

Genom att förifylla avtal med data från ert system sparar ni både tid och säkerställer att rätt uppgifter följer med i avtalen.

Ni kan sedan tidigare ha förberett mallar i DealBuilder som innehåller era egna avtalstexter, villkor och bilagor. När användaren startar ett nytt avtal från sitt system behöver de bara justera innehållet i avtalsmallen innan de skickar ut en offert eller ett avtal – detta kan göras på några sekunder.

För att detta ska fungera måste de berörda användarna också ha användaråtkomst i DealBuilder och redan vara inloggade i DealBuilder.

‍

📦 Produktmodul för dynamiska avtal

DealBuilder har också en egen produktmodul som gör det möjligt att lägga till produkter direkt i avtalsmallarna på ett dynamiskt sätt.

Det betyder att användaren, utöver förifylld kundinformation, även kan lägga till produkter från produktbiblioteket i DealBuilder innan avtalet eller offerten skickas för signering. Detta ger en snabb, flexibel och heltäckande process för både kundavtal och offerthantering.

‍

🎥 Se hur det fungerar

Vill du se hur du kan integrera DealBuilder med dina egna system?
Vi har skapat en kort video som visar hela processen – från konfiguration av webhooks till testning och användning.

👉 Så här sätter du upp en ny webhook: https://www.loom.com/share/7e9821361b1f4e2e952c3eab538b1c34?sid=4d93fdd8-6e2d-4a2d-890c-d2a66ca08bd7

👉 Så här kan du skicka data till DealBuilder (GET-förfrågan /Query URL): https://www.loom.com/share/87d7c294d1fa4e28870c4fbeae4a992e?sid=676db381-5536-4252-b542-18279ef1335f

‍

🔌 3. Integration via API

DealBuilders API ger dig flexibel och kraftfull automatisering för hela dokumentflödet – både för färdiga PDF-filer och mallbaserade dokument.

API-dokumentation

Fullständig teknisk dokumentation för DealBuilders API hittar du här:
https://api.dealbuilder.io/swagger/index.html

Dokumentationen finns också tillgänglig i JSON-format:
https://api.dealbuilder.io/swagger/v1/swagger.json

JSON-versionen kan bland annat användas tillsammans med AI-verktyg för hjälp med att utveckla och felsöka integrationer. API:et har basadressen https://api.dealbuilder.io och använder API-nyckel i x-api-key-headern för autentisering.

‍

📌 Tre huvudtyper av dokumentflöde via API:

1. PDF-signering (automatisk)
   Skicka in en färdig PDF med signatärer och eventuella anpassade fält/metadata. Mall-ID styr tidsfrister, signeringsmetod, aviseringar och mer. Dokumentet skickas automatiskt för signering och webhooks ger dig uppdateringar tillbaka.
2. Dokument genererat från mall (automatiskt)
   Externt system skickar in data som produkter, antal, priser, rabatt, villkor, bilagor osv. DealBuilder genererar dokumentet baserat på mallen och skickar det automatiskt för signering. Webhooks ger dig uppdateringar tillbaka.
3. Halvautomatiskt dokumentflöde
   Samma som ovan, men användaren får möjlighet att göra justeringar i dokumentet innan det skickas ut manuellt från DealBuilder. Perfekt när något bör kvalitetssäkras före utskick. Webhooks ger dig uppdateringar tillbaka.
   ‍

Möjligheter med DealBuilder API

DealBuilders API gör det möjligt att automatisera hela dokumentflödet från egna system. Du kan bland annat:

• Skapa dokument från mallar eller färdiga PDF-filer.
• Skapa dokument som utkast eller skicka dem direkt för signering.
• Hantera dokument, hämta dokumentinformation och följa signeringsstatus.
• Hämta signerade PDF-filer och tillhörande dokumentdata.
• Söka, filtrera och sortera dokument, bland annat med fritextsökning, signeringsdatum och dokumentnummer.
• Skapa, uppdatera och synkronisera produkter.
• Överföra anpassade fält, metadata, produkter, priser, villkor och bilagor.
• Hämta signeringslänkar och integrera signeringsprocessen i egna system.
• Ta emot automatiska uppdateringar om dokumenthändelser via webhooks.

Se fullständig guide för hur du sätter upp API-integrationer här.

‍

Organisationshierarki för koncerner och partners

DealBuilder stöder organisationshierarkier med obegränsat antal nivåer av organisationer och företag. Detta gör det möjligt att spegla strukturen i större koncerner, verksamheter med många avdelningar eller partnerorganisationer. API och webhooks kan administreras centralt på en överordnad nivå och gälla för hela organisationshierarkin. Därmed kan man etablera en gemensam integration som hanterar dokumentflödet över flera företag och avdelningar.
‍

Personnummer vid BankID-signering

För godkända kunder kan DealBuilder också tillgängliggöra signatärens personnummer genom integrationen vid BankID-signering. Åtkomsten måste aktiveras separat.

‍

Integrerad signering (embedded signing)

DealBuilder stöder integrerade signeringsflöden där signeringslänkar kan hämtas via API och presenteras direkt i kundens eget system, utan att signeringsinbjudan behöver skickas via DealBuilder. Automatisk utskickning av färdigsignerade dokument till signatärerna kan också inaktiveras per dokumentmall. Därmed kan verksamheten själv hantera både utskick av signeringslänkar och kommunikation efter slutförd signering.

‍

🔄 Produktsynkronisering

API:et kommer också att stödja synkronisering av produkter mellan DealBuilder och dina egna system, så att du alltid har uppdaterad produktdata tillgänglig i dina dokument.

‍

📧 Behöver du hjälp med integrationer?

Du kan sätta upp integrationerna själv med hjälp av API, webhooks eller GET-förfrågningar, få råd eller hjälp av oss, eller kontakta en av våra integrationspartners för hjälp. Våra partners hjälper dig att bygga skräddarsydda integrationer som passar dina behov och automatiserar viktiga processer.

👉 Kontakta oss via vårt kontaktformulär, så hjälper vi dig att komma igång.

‍