Documentation, examples, and use cases of the LCAbyg Web API.
Please be aware that the scope of underlying software architecture is broader than the LCAbyg Web API.
- Get a free API_KEY at https://api.lcabyg.dk/
- Clone the repo
git clone https://github.com/build-aau/lcabyg_web_api_doc.git- Enter your USERNAME and an API_KEY in the example.py or example_explanation.py
USERNAME = 'INSERT YOUR USERNAME'
API_KEY = 'INSERT YOUR API KEY'- Based on the login, generate and api access TOKEN that is then used for authentication for all API calls.
- Before sending a job, ensure your json projects are compatible with LCAbyg JSON standard.
- api.md
- csv.md
- Error messages are located in the output JSON data, "extra_output." We are currently working on improving the debug-functionality and provide more user-friendly error messages.
- example.py for using the python packages lcabyg_web_api_py and sbi_web_api_py. In the future, these will be Python libraries.
- example_explanation.py step-by-step explanation of the LCAbyg Web API.
Distributed under the BSD 2-Clause License. See LICENSE.md for more information.
If you have a suggestion that would make this better, you are welcome to create a pull request.
- postman configuration. Thanks to Tore Hvidegaard and 3dbyggeri danmark ApS.
- Sensitivity analyse (WIP). Developed by Lærke Vejsnæs during her masters thesis spring 2023 [email protected].
If you have a project that uses the LCAbyg Web API, we would love to feature your project here and on the LCAbyg Web API website. Contact Christian Grau Sørensen [email protected]