Getting Started with the API
Getting Started with the API
Welcome to the Eriksson Beam API! This guide will help you get up and running quickly.
What is the Eriksson Beam API?
The Eriksson Beam API is a .NET library that allows you to programmatically interact with the Eriksson Beam desktop application. You can automate beam design workflows, batch process multiple projects, and integrate Eriksson Beam into your own applications.
Prerequisites
Before you begin, ensure you have:
- .NET Framework 4.7.2+ or .NET 6+
- Eriksson Beam desktop application installed
- API License Key (contact Eriksson Software for access)
Quick Start
- Install the Package - Set up the local NuGet package
- Configure Your License - Set up your API license key
- Make Your First Connection - Connect and pull data in under 5 minutes
What Can You Do?
| Operation | Description |
|---|---|
| Pull Data | Retrieve all input data from an open beam project |
| Push Data | Update input fields in Eriksson Beam |
| File Management | Create, open, and save beam project files |
| Batch Processing | Process multiple files programmatically |
Download Sample Project
Get started quickly with our ready-to-run sample project:
This minimal console application demonstrates:
- Launching Eriksson Beam programmatically
- Pulling design data from an open project
- Modifying project information properties
- Pushing changes back to Eriksson Beam
Simply download, update the license key and file paths in Program.cs, and run!
Supported Input Tabs
The API provides access to data from these Eriksson Beam input tabs:
- Concrete Extents - Section geometry (T-Beam, I-Beam, Rectangular, etc.)
- Design Criteria - Project info, materials, load combinations, settings
- Structural Model - Loading, bearing, dapped ends, shoring
- Reinforcement - Prestress, rebar, transverse, welded wire
Note: Polygonal sections are not currently supported by the API.
Next Steps
Ready to get started? Head to the Installation Guide to set up the API package.