Hopp til hovedinnholdet
Logg på

SmartCraft Spark API

Andrea Arnesen
  • Oppdatert

REST API-dokumentasjon for SmartCraft Spark OpenAPI. Alle endepunkter bruker GET-metoden og returnerer JSON-responser.

Basis-URL

https://api.spark.smartcraft.cloud

Alle endepunktstier er relative til denne basis-URLen. For eksempel er den fullstendige URLen for tilbudsdetaljer-endepunktet:
https://api.spark.smartcraft.cloud/open-api/v1/offers/offer-details

________________________________________________________________________________________________________________________

Autentisering

SmartCraft Spark API bruker Client ID og Client Secret for autentisering. Du må generere disse fra Spark-applikasjonen.

Viktig: Kun brukere med Kontoeier-tilgang kan opprette API-legitimasjon.
 

Steg 1: Naviger til Integrasjoner

Gå til https://spark.smartcraft.app/user/integrations og velg fanen API-legitimasjon.

Spark Integrations page showing API credentials tab

Steg 2: Opprett ny legitimasjon

Klikk Ny API-legitimasjon og skriv inn et beskrivende navn for integrasjonen (f.eks. «Dashboard-integrasjon», «Power BI»).

New API credential dialog with name field

Steg 3: Kopier legitimasjonen din

Etter å ha klikket Generer API-legitimasjon, vil du få vist din Client ID og Client Secret. Kopier begge verdiene og lagre dem sikkert.

Advarsel: Dette er den eneste gangen den fullstendige legitimasjonen vises. Client Secret er ikke gjenvinnbar — hvis du mister den, må du generere ny legitimasjon.
 

Generated API credential showing Client ID and Client Secret

Tilbud

GET /open-api/v1/offers/offer-details
 

Hent tilbudsdetaljer for leietaker

Returnerer aggregert tilbudsstatistikk for gjeldende leietaker, inkludert totalverdier, antall og gjennomsnitt på tvers av alle tilbud.

Parametere

Ingen

Responser
 
200 OK — returns GetTenantOfferDetailsResponse
404 Ikke funnet
500 Intern serverfeil
 
Responsskjema
 
{ 
"openOffersValue": number (double), 
"acceptedOffersValue": number (double),
"totalOffersValue": number (double), 
"averageAcceptedOffersValue": number (double), 
"medianAcceptedOffersValue": number (double), 
"totalNumberOfOffers": integer (int32), 
"totalNumberOfSentOffers": integer (int32), 
"totalNumberOfAcceptedOffers": integer (int32), 
"totalNumberOfExpiredOffers": integer (int32) 
}
________________________________________________________________________________________________________________________
 
GET /open-api/v1/offers/meta-data
 

Hent tilbudsmetadata

Returnerer en paginert liste over tilbudsmetadata.

Parametere
Navn I Type Påkrevd Standard Beskrivelse
pageNumber query integer (int32) Nei 0 Sidenummer (nullbasert)
pageSize query integer (int32) Nei 50 Antall poster per side
Responser
 
200 OK — returns array ofOfferMetaDataResponse
404 Ikke funnet
500 Intern serverfeil
 
________________________________________________________________________________________________________________________
 
GET /open-api/v1/offers/{offerId}/customer-information
 

Hent kundeinformasjon for tilbud

Returnerer kundedetaljene knyttet til et spesifikt tilbud.

Parametere
Navn I Type Påkrevd Beskrivelse
offerId path string (uuid) Ja * Unik identifikator for tilbudet
Responser
 
200 OK — returnsOfferCustomerInformation
404 Ikke funnet
500 Intern serverfeil
 
Responsskjema
 
{ 
"id": string (uuid), 
"orgNumber": string, 
"type": string, 
"name": string, 
"country": string, 
"address": string, 
"postalCode": string, 
"postalArea": string, 
"email": string, 
"phoneNumber": string 
}
________________________________________________________________________________________________________________________
 
GET /open-api/v1/offers/{offerId}/worksite-information
 

Hent arbeidsstedinformasjon for tilbud

Returnerer arbeidssteddetaljer knyttet til et spesifikt tilbud.

Parametere
Navn I Type Påkrevd Beskrivelse
offerId path string (uuid) Ja * Unik identifikator for tilbudet
Responser
 
200 OK — returnsOfferWorksiteInformation
404 Ikke funnet
500 Intern serverfeil
 
________________________________________________________________________________________________________________________
 
GET /open-api/v1/offers/{offerId}/offer-items
 

Hent tilbudsposter

Returnerer den flate listen over poster (produkter, materialer, arbeid) for et spesifikt tilbud.

Parametere
Navn I Type Påkrevd Beskrivelse
offerId path string (uuid) Ja * Unik identifikator for tilbudet
Responser
 
200 OK — returns array ofOfferLineItems
404 Ikke funnet
500 Intern serverfeil
 
Responsskjema (hvert element)
 
{ 
"nodeId": string (uuid), 
"itemName": string, 
"productNumber": string, 
"brand": string, 
"unitType": string, 
"quantity": number (double), 
"unitCost": number (double), 
"totalCost": number (double), 
"surchargePercentage": number (double), 
"surcharge": number (double), 
"unitPrice": number (double), 
"discountPercentage": number (double), 
"discountAmount": number (double), 
"unitSalesPrice": number (double), 
"totalSalesPrice": number (double), 
"marginPercentage": number (double), 
"margin": number (double), 
"itemType": string 
}
________________________________________________________________________________________________________________________
 
GET /open-api/v1/offers/{offerId}/offer-tree
 

Hent tilbudstre

Returnerer den hierarkiske trestrukturen til et tilbud, som representerer den nestede oppdelingen av seksjoner og poster.

Parametere
Navn I Type Påkrevd Beskrivelse
offerId path string (uuid) Ja * Unik identifikator for tilbudet
Responser
 
200 OK — returnsOfferTreeItem
404 Ikke funnet
500 Intern serverfeil
________________________________________________________________________________________________________________________
 

Leietakere

GET /open-api/v1/tenants/tenant-information
 

Hent leietakerinformasjon

Returnerer utvidet informasjon om gjeldende leietaker.

Parametere

Ingen

Responser
 
404 Ikke funnet
500 Intern serverfeil
________________________________________________________________________________________________________________________
 

Skjemaer

GetTenantOfferDetailsResponse

Egenskap Type Beskrivelse
openOffersValue number (double) Totalverdi av åpne (ventende) tilbud
acceptedOffersValue number (double) Totalverdi av aksepterte tilbud
totalOffersValue number (double) Samlet verdi av alle tilbud
averageAcceptedOffersValue number (double) Gjennomsnittlig verdi av aksepterte tilbud
medianAcceptedOffersValue number (double) Medianverdi av aksepterte tilbud
totalNumberOfOffers integer (int32) Totalt antall tilbud
totalNumberOfSentOffers integer (int32) Antall tilbud som er sendt
totalNumberOfAcceptedOffers integer (int32) Antall aksepterte tilbud
totalNumberOfExpiredOffers integer (int32) Antall utløpte tilbud

OfferMetaDataResponse

Egenskap Type Beskrivelse
id string (uuid) Unik identifikator for tilbudet
name string Tilbudsnavn
acceptedByName string Navnet på personen som aksepterte tilbudet
offerStatus string Gjeldende status for tilbudet
createdBy string (uuid) ID-en til brukeren som opprettet tilbudet
caseworkerName string Navnet på den tildelte saksbehandleren
acceptedAt string (date-time) Tidsstempel for når tilbudet ble akseptert
createdAt string (date-time) Tidsstempel for når tilbudet ble opprettet
validUntil string (date-time) Utløpsdato for tilbudet
workCost number (double) Total arbeidskostnad
workHours number (double) Totale arbeidstimer
materialCost number (double) Total materialkostnad
margin number (double) Marginbeløp
marginPercentage number (double) Margin i prosent
salesPriceExclVat number (double) Salgspris ekskl. mva.
salesPriceInclVat number (double) Salgspris inkl. mva.
messageContent string Melding / notatinnhold
attachments string (byte) Base64-kodet vedleggsdata

OfferCustomerInformation

Egenskap Type Beskrivelse
id string (uuid) Unik identifikator for kunden
orgNumber string Organisasjons- / firmaregistreringsnummer
type string Kundetype (f.eks. bedrift, privat)
name string Kundenavn
country string Land
address string Gateadresse
postalCode string Post- / postnummer
postalArea string Poststed / by
email string E-postadresse for kontakt
phoneNumber string Kontakttelefonnummer

OfferWorksiteInformation

Egenskap Type Beskrivelse
id string (uuid) Unik identifikator for arbeidsstedet
description string Arbeidsstedbeskrivelse
country string Land
address string Gateadresse
postalCode string Post- / postnummer
postalArea string Poststed / by

OfferLineItems

Egenskap Type Beskrivelse
nodeId string (uuid) Unik identifikator for denne postnoden
itemName string Navn på posten
productNumber string Produkt- / artikkelnummer
brand string Merkenavn
unitType string Måleenhet (f.eks. stk, m, kg)
quantity number (double) Antall
unitCost number (double) Kostnad per enhet
totalCost number (double) Totalkostnad (antall × enhetskostnad)
surchargePercentage number (double) Påslag i prosent
surcharge number (double) Påslagsbeløp
unitPrice number (double) Pris per enhet (etter påslag)
discountPercentage number (double) Rabatt i prosent
discountAmount number (double) Rabattbeløp
unitSalesPrice number (double) Salgspris per enhet
totalSalesPrice number (double) Total salgspris
marginPercentage number (double) Margin i prosent
margin number (double) Marginbeløp
itemType string Type tilbudspost

OfferTreeItem

Representerer en node i det hierarkiske tilbudstreet. Hver node kan inneholde underordnede noder via den rekursive children-arrayen.

Egenskap Type Beskrivelse
nodeId string (uuid) Unik identifikator for noden
nodeType string Type trenode
itemName string Postnavn
productNumber string Produkt- / artikkelnummer
brand string Merkenavn
unitType string Måleenhet
quantity number (double) Antall
unitCost number (double) Kostnad per enhet
totalCost number (double) Totalkostnad
surchargePercentage number (double) Påslagsprosent
surcharge number (double) Påslagsbeløp
unitPrice number (double) Pris per enhet
discountPercentage number (double) Rabattprosent
discountAmount number (double) Rabattbeløp
unitSalesPrice number (double) Salgspris per enhet
totalSalesPrice number (double) Total salgspris
marginPercentage number (double) Marginprosent
margin number (double) Marginbeløp
isSumLevel boolean Om denne noden er et summeringsnivå
hierarchyNumber string Posisjon i hierarkiet (f.eks. «1.2.3»)
posNumber string Posisjonsnummer
children array of OfferTreeItem Underordnede noder (rekursiv)

GetExtendedTenantInformationQuery

Utvidet leietakerinformasjonsobjekt. Ingen ytterligere egenskaper er definert i gjeldende spesifikasjonsversjon.

 

Forbundet med

Relaterte artikler

Kommentarer

0 kommentarer

Artikkelen er stengt for kommentarer.