Gå til innholdet

Brukerveiledning for API & Integrasjon

Velkommen til Byggsoft for API & Integrasjon.

Byggsoft API gir utviklere, programvarehus, prefabrikasjonsfabrikker, trelastleverandører og rådgivende ingeniørselskaper direkte tilgang til den skybaserte FEA- og Eurokode-beregningsmotoren (beam-api).

Med Byggsoft API kan du:

  • Kjøre automatiserte konstruksjonsberegninger rett fra egne nettsider, nettbutikker eller interne ERP-systemer.
  • Bygge skreddersydde konfigureringsverktøy (for eksempel garasje-, carport- eller takstolkonfiguratorer).
  • Kjøre parametrisk dimensjonering og optimalisering fra Python eller FreeCAD.
  • Motta verifiserte Eurokode-resultater (moment, skjær, nedbøyning, utnyttelse) som strukturert JSON.

Hva er inkludert i API-abonnementet?

TjenesteBeskrivelse
REST API EndepunkterHøyytende JSON HTTP-endepunkter for 1D bjelker, søyler, 2D/3D fagverk og rammer.
Profil- & MaterialdatabaseTilgang til hele det norske tverrsnittsbiblioteket (stål HEA/HEB/IPE/RHS/SHS, tre C24/C30/limtre GL30c, betongkvaliteter).
Kommunale MiljølasterOppslag av snø- og vindlaster basert på kommunenummer/navn og meter over havet (NS-EN 1991).
FreeCAD FEM Plugin & PythonFerdig integrasjonsmodul og Python-skript for å overføre CAD-geometri direkte til Byggsoft-motoren.
Høy Ytelse & OppetidDedikert kapasitet, sub-sekunds responstid på typiske konstruksjoner og 99.9% oppetid.
UtviklerstøtteDirekte teknisk bistand fra Byggsofts beregningsteam for integrasjon og schema-oppsett.

1. Autentisering & Sikkerhet

Alle kall mot Byggsoft REST API krever en gyldig API-nøkkel eller et Bearer-token i HTTP-headeren:

Authorization: Bearer DIN_API_NOKKEL_HER
Content-Type: application/json

API-nøkler genereres i Byggsoft-dashboardet under Organisasjonsinnstillinger → API-nøkler. Hold nøkkelen hemmelig og benytt alltid HTTPS.


2. Rask Eksempelforespørsel (1D Bjelke)

Her er et eksempel på en POST-forespørsel til /api/v1/calculate/beam med en fritt opplagt limtrebjelke med spenn 6.0 meter6.0\text{ meter}, jevn linjelast og punktlast:

HTTP Request (JSON)

{
"length": 6.0,
"material": {
"type": "TIMBER",
"grade": "GL30c",
"serviceClass": 1,
"loadDurationClass": "MEDIUM_TERM"
},
"crossSection": {
"type": "RECTANGULAR",
"width": 90,
"height": 300
},
"supports": [
{ "position": 0.0, "type": "PINNED" },
{ "position": 6.0, "type": "ROLLER" }
],
"loads": [
{ "type": "DISTRIBUTED", "startPos": 0.0, "endPos": 6.0, "magnitude": 2.5, "loadCase": "DEAD_LOAD" },
{ "type": "DISTRIBUTED", "startPos": 0.0, "endPos": 6.0, "magnitude": 4.2, "loadCase": "SNOW_LOAD" }
]
}

HTTP Response (JSON)

Byggsoft returnerer fullstendige snittkrefter, Eurokode-utnyttelse og nedbøyning:

{
"status": "SUCCESS",
"governingState": "ULS",
"maxUtilization": 0.74,
"bendingCheck": {
"designMoment": 30.15,
"capacityMoment": 40.74,
"utilization": 0.74,
"passed": true
},
"shearCheck": {
"designShear": 20.10,
"capacityShear": 54.00,
"utilization": 0.37,
"passed": true
},
"deflectionCheck": {
"instantaneous": 11.2,
"final": 14.8,
"allowable": 20.0,
"utilization": 0.74,
"passed": true
},
"reactions": [
{ "position": 0.0, "Rz": 20.1 },
{ "position": 6.0, "Rz": 20.1 }
]
}

3. FreeCAD FEM Integrasjon & Python Makroer

For CAD-baserte arbeidsflyter har Byggsoft utviklet et åpent Python-tillegg for FreeCAD:

  1. Eksport fra FreeCAD: Tegn eller parametriser konstruksjonen i FreeCAD Draft, Arch eller FEM Workbench.
  2. Kjør Byggsoft Makro: Makroen ekstraherer senterlinjer, nodenettverk og randbetingelser, og sender payload til Byggsoft API.
  3. Visning av Resultater: Makroen leser responskreftene og fargelegger tverrsnittene i FreeCAD med utnyttelsesgrader og deformasjonskurver.

Les full veiledning under FreeCAD Macro & FEM Integrasjon.


4. Rater, Kvote & Feilhåndtering

  • Feilkoder: API-et benytter standard HTTP-statuskoder:
    • 200 OK: Beregning fullført og validert.
    • 400 Bad Request: Ugyldig geometri, manglende opplegg eller ustabil konstruksjon (mekanisme). Detaljert feilmelding i JSON-responsen.
    • 401 Unauthorized: Manglende eller ugyldig API-token.
    • 429 Too Many Requests: Kvote overskredet.
  • Batch-beregninger: For optimalisering eller dimensjonering av hele byggesett kan du sende batch-forespørsler via /api/v1/calculate/batch.

Relevante lenker for API-utviklere