Gå til innholdet

REST API Dokumentasjon

Byggsoft REST API tilbyr et moderne, sikkert JSON-grensesnitt for integrasjon av beregninger direkte i tredjeparts applikasjoner.

[!NOTE] Partneravtale API-tilgang krever en gyldig partneravtale og API-nøkkel. Vennlig ta kontakt med Byggsoft AS for mer informasjon.


1. Autentisering

Alle forespørsler mot Byggsoft API må inkludere din unike partnernøkkel i HTTP-headeren:

Authorization: Bearer DIN_PARTNER_API_NOKKEL
X-Byggsoft-Client: DittSelskapsNavn/1.0
Content-Type: application/json

Base URL:

  • Produksjon: https://api.byggsoft.no/v1
  • Sandbox (Test): https://sandbox-api.byggsoft.no/v1

2. Endepunkt: Bjelkeberegning (POST /v1/calculate/beam)

Beregner en fritt opplagt eller kontinuerlig bjelke med Eurokode-kapasitetskontroll.

Forespørsel (Request Payload):

{
"project": {
"name": "Lagerbygg Halden",
"engineer": "Ola Nordmann",
"reliabilityClass": "RC2"
},
"geometry": {
"spans": [8.0],
"cantileverLeft": 0.0,
"cantileverRight": 0.0
},
"material": {
"type": "TIMBER_GLULAM",
"grade": "GL30c",
"serviceClass": 1
},
"crossSection": {
"type": "RECTANGULAR",
"widthMm": 140,
"heightMm": 495
},
"loads": [
{
"type": "PERMANENT",
"category": "DEAD_LOAD",
"distribution": "UNIFORM",
"valueKnm": 2.22
},
{
"type": "VARIABLE",
"category": "SNOW",
"duration": "SHORT",
"distribution": "UNIFORM",
"valueKnm": 6.72
}
]
}

Svar (Response Payload):

{
"status": "SUCCESS",
"calculationId": "calc_89b21e84",
"summary": {
"overallStatus": "APPROVED",
"maxUtilization": 0.81,
"criticalCheck": "BENDING_MY_ED"
},
"results": {
"internalForces": {
"maxMomentKnm": 101.9,
"maxShearKn": 51.0,
"supportReactionsKn": [51.0, 51.0]
},
"deflections": {
"instantaneousMm": 25.9,
"finalMm": 32.0,
"limitFinalMm": 32.0,
"utilizationDeflection": 1.00
},
"checks": [
{
"clause": "NS-EN 1995-1-1 6.1.6",
"description": "Bøyespenning om sterk akse",
"appliedValueMpa": 17.82,
"capacityValueMpa": 22.01,
"utilization": 0.81,
"status": "PASS"
},
{
"clause": "NS-EN 1995-1-1 6.1.7",
"description": "Skjærspenning med rissfaktor k_cr=0.67",
"appliedValueMpa": 1.65,
"capacityValueMpa": 2.52,
"utilization": 0.65,
"status": "PASS"
}
]
}
}

3. Endepunkt: Fagverksberegning (POST /v1/calculate/truss)

Beregner vilkårlige eller parametriske 2D og 3D fagverk (f.eks. Fink, Loftstakstol, Saksestakstol, Pulttakstol, Mansardtakstol eller gitterdragere) med full Eurokode 5 trevirke- og stålkapasitetskontroll (NS-EN 1995-1-1), automatiske lastkombinasjoner etter NS-EN 1990 Tabell NA.A1.2(B), nedbøyningskontroll (SLS med kryp kdefk_{def}), vindsug- og forankringsberegning, samt direkte eksportlenker til DXF (CAD), IFC 4 (3D BIM) og SAF v2.0 (Excel).

Forespørsel (Request Payload):

{
"project": {
"name": "Enebolig Vestby - Takstoler",
"engineer": "Kari Ingeniør",
"reliabilityClass": "RC2",
"nationalAnnex": "NO"
},
"truss": {
"template": "fink",
"spanMeters": 10.0,
"pitchDegrees": 27.0,
"overhangMeters": 0.5,
"spacingMeters": 0.60
},
"materials": {
"topChord": { "category": "timber", "grade": "C24", "widthMm": 48, "heightMm": 198 },
"bottomChord": { "category": "timber", "grade": "C24", "widthMm": 48, "heightMm": 198 },
"webMembers": { "category": "timber", "grade": "C24", "widthMm": 48, "heightMm": 98 }
},
"environmentalLoads": {
"location": "Vestby",
"snowSkKnm2": 3.5,
"windVbMs": 22.0,
"deadLoadRoofKnm2": 0.65,
"ceilingDeadLoadKnm2": 0.30
},
"options": {
"generateLoadCombinations": true,
"includeSecondOrderEffects": true,
"generateBimFiles": true
}
}

Alternativ: For egendefinerte fagverk kan du sende inn eksplisitte lister over nodes (x,y,zx, y, z), members (startNode, endNode, profil) og supports i stedet for template.

Svar (Response Payload):

{
"status": "SUCCESS",
"calculationId": "truss_fink_10m_98c1",
"summary": {
"overallStatus": "APPROVED",
"maxUtilization": 0.74,
"governingCombination": "ULS 6.10b (Snø styrende, γQ=1.50)",
"criticalMember": {
"id": "m1",
"role": "topChord",
"axialForceKn": -38.4,
"momentKnm": 1.45,
"utilization": 0.74,
"clause": "NS-EN 1995-1-1 6.3.2 (Kombinert trykk og knekking)"
}
},
"eurocodeChecks": {
"tension": { "maxUtil": 0.42, "status": "PASS" },
"compressionBuckling": { "maxUtil": 0.74, "status": "PASS" },
"slsDeflection": {
"instantaneousMm": 6.8,
"finalCreepMm": 11.4,
"limitMm": 33.3,
"utilization": 0.34,
"status": "PASS"
},
"supportBearing": {
"requiredBearingLengthMm": 68.0,
"providedBearingLengthMm": 100.0,
"utilization": 0.68,
"status": "PASS"
},
"windUplift": {
"hasUplift": true,
"maxUpliftKn": 4.12,
"recommendedTieDown": "2x Simpson Strong-Tie BMF 90x90 vinkelbeslag med kamsøm"
}
},
"exports": {
"dxfCadUrl": "https://api.byggsoft.no/v1/exports/truss_fink_10m_98c1.dxf",
"ifc4BimUrl": "https://api.byggsoft.no/v1/exports/truss_fink_10m_98c1.ifc",
"safExcelUrl": "https://api.byggsoft.no/v1/exports/truss_fink_10m_98c1_saf.xlsx",
"pdfReportUrl": "https://api.byggsoft.no/v1/report/pdf?calculationId=truss_fink_10m_98c1"
}
}

Python Integrasjonseksempel:

import requests
url = "https://api.byggsoft.no/v1/calculate/truss"
headers = {
"Authorization": "Bearer DIN_PARTNER_API_NOKKEL",
"Content-Type": "application/json"
}
payload = {
"project": {"name": "Industrihall Fagverk", "nationalAnnex": "NO"},
"truss": {"template": "fink", "spanMeters": 12.0, "spacingMeters": 0.6},
"materials": {
"topChord": {"category": "timber", "grade": "C24", "widthMm": 48, "heightMm": 198},
"bottomChord": {"category": "timber", "grade": "C24", "widthMm": 48, "heightMm": 198}
},
"environmentalLoads": {"snowSkKnm2": 4.0, "windVbMs": 24.0, "deadLoadRoofKnm2": 0.70}
}
response = requests.post(url, json=payload, headers=headers)
data = response.json()
print(f"Status: {data['summary']['overallStatus']}")
print(f"Maks utnyttelse: {data['summary']['maxUtilization'] * 100:.1f}%")
print(f"BIM IFC4: {data['exports']['ifc4BimUrl']}")

4. Endepunkt: Generer PDF-Rapport (POST /v1/report/pdf)

Sender inn en calculationId eller hele modellen, og returnerer en ferdig sertifisert PDF-rapport som en binær datastrøm (application/pdf).

cURL Eksempel:

Terminal window
curl -X POST https://api.byggsoft.no/v1/report/pdf \
-H "Authorization: Bearer DIN_PARTNER_API_NOKKEL" \
-H "Content-Type: application/json" \
-d '{"calculationId": "truss_fink_10m_98c1", "includeWatermark": false}' \
--output fagverk_beregningsrapport.pdf

5. Feilkoder og Hastighetsbegrensninger (Rate Limits)

  • 200 OK: Beregning fullført og validert.
  • 400 Bad Request: Ugyldig geometri, manglende påkrevde parametere eller udefinert profil.
  • 401 Unauthorized: Manglende eller ugyldig API-nøkkel.
  • 429 Too Many Requests: Standard partnerkvote overskredet (normalt 600 kall/minutt).
  • 500 Internal Error: Ulineær numerisk divergens i solver.

For økt rate-limit eller dedikert sky-klynge, vennlig ta kontakt med Byggsoft AS for mer informasjon.