API

Poprzez API jest możliwość wykorzystania silnika cieplo.app we własnej aplikacji, która może wyglądać i być zorganizowana prawie w dowolny sposób.

Obsługiwane kraje: Polska, Niemcy, Austria, Czechy, Słowacja, Wielka Brytania, Holandia.

• Cennik
• Zasady korzystania z API

Uwagi, życzenia, skargi, pytania i zażalenia odnośnie API można kierować zwyczajowymi drogami kontaktu.

Autoryzacja

Każdy użytkownik posiada indywidualny klucz dostępu do API, który należy dołączyć do każdego żądania jako parametr GET o nazwie token. Klucz dostępu do API można znaleźć w panelu konta.

Jeśli użytkownik ma aktywną subskrypcję z dostępme do API – jego klucz jest w pełni funkcjonalny. W przeciwnym wypadku klucz działa w trybie testowym – do celów wdrożeniowych. Obliczenia przesłane za pomocą testowego klucza API przechodzą walidację, ale nie są zapisywane na serwerze. Zwracane w odpowiedzi wartości zawsze dotyczą jednego i tego samego oszacowania, które już istnieje w bazie (jest zwracany jego identyfikator, więc można pobrać całość w osobnym żądaniu).

Nowe oszacowanie

POST https://cieplo.app/api/calculation

Żądanie

Treść żądania należy przesłać jako application/json.

Wszystkie parametry są obowiązkowe – poza opisanymi jako warunkowe lub opcjonalne. Poniższy przykład dla ilustracji zawiera wszystkie parametry, także te, które w tym typie budynku nie są potrzebne.

{
	"building_type": "single_house",
	"construction_year": 2020,
	"construction_type": "traditional",
	"latitude": 51.4453433,
	"longitude": 16.2334445,
	"building_length": 12.5,
	"building_width": 6,
	"floor_area": 45,
	"floor_perimeter": 125,
	"building_floors": 3,
	"building_heated_floors": [0, 1, 2],
	"floor_height": 2.6,
	"building_roof": "steep",
	"has_basement": true,
	"has_balcony": true,
	"has_garage": false,
	"garage_type": "double_unheated",
	"wall_size": 65,
	"primary_wall_material": 57,
	"secondary_wall_material": null,
	"internal_wall_isolation": {
		"material": 88,
		"size": 5
	},
	"external_wall_isolation": {
		"material": 88,
		"size": 15
	},
	"top_isolation": {
		"material": 68,
		"size": 35
	},
	"bottom_isolation": {
		"material": 71,
		"size": 5
	},
	"number_doors": 2,
	"number_balcony_doors": 2,
	"number_windows": 12,
	"number_huge_windows": 0,
	"doors_type": "new_metal",
	"windows_type": "new_double_glass",
	"indoor_temperature": 21,
	"ventilation_type": "natural",
	"include_hot_water": true,
	"hot_water_persons": 3,
	"hot_water_usage": "shower_bath",
	"whats_over": "heated_room",
	"whats_under": "heated_room",
	"whats_north": "heated_room",
	"whats_south": "unheated_room",
	"whats_east": "heated_room",
	"whats_west": "outdoor",
	"on_corner": true,
	"unheated_space_under_type": "worst",
	"unheated_space_over_type": "great"
}

Odpowiedź – sukces

Póki co zwracane są tylko te podstawowe dane, które – jak się naszemu jednoosobowemu zespołowi wydawało – będą potrzebne użytkownikom API. Daj znać jeśli potrzebujesz czegoś więcej spośród treści, jakie znajdują się na stronie z wynikiem.

{
	"result": {
		"id": 12345,
		"total_area": 145,
		"heated_area": 145,
		"max_heating_power": 5.2,
		"avg_heating_power": 2.5,
		"bivalent_point_heating_power": 4.6,
		"hot_water_power": 0.5,
		"annual_energy_consumption": 12345,
		"annual_energy_consumption_factor": 123,
		"heating_power_factor": 155,
		"design_outdoor_temperature": -20,
		"avg_outdoor_temperature": 1.24
	}
}
            

Odpowiedź – błędy

{
	"errors": {
		"internal_wall_isolation": "Pole wymagane."
	}
}
            

Pobranie wyniku

GET https://cieplo.app/api/calculation/{id}

Odpowiedź

{
	"parameters": {
		...
	},
	"result": {
		"id": 12345,
		"total_area": 145,
		"heated_area": 145,
		"max_heating_power": 5.2,
		"avg_heating_power": 2.5,
		"bivalent_point_heating_power": 4.6,
		"annual_energy_consumption": 12345,
		"annual_energy_consumption_factor": 123,
		"heating_power_factor": 155,
		"design_outdoor_temperature": -20,
		"avg_outdoor_temperature": 1.24
	}
}
            

Pobranie wyniku – wersja rozszerzona

GET https://cieplo.app/api/calculation/{id}?extended=1

Dodatkowo zwracane są: dane z wykresu z kosztami energii/paliw, lista najbardziej opłacalnych modernizacji budynku oraz dane z wykresu dot. strat ciepła.

Odpowiedź

{
	"parameters": {
		...
	},
	"result": {
		...
	},
	"heating_costs": [
	{
		"label": "Kocioł na drewno bez podajnika",
		"detail": "Ecodesign, z buforem ciepła",
		"fuel": {
			"name": "Drewno",
			"price": 1,
			"unit": "kg",
			"trade_amount": 450,
			"trade_unit": "mp",
			"energy": 16.00
		},
		"amount": 10651,
		"consumption": 23.7,
		"efficiency": 80,
		"cost": 9586
	},
	...
	],
	"improvements": [{
		"label": "ocieplenie dachu 20cm styropianu",
		"energy_saved": 35
	}, {
		"label": "wentylacja mechaniczna z odzyskiem ciepła",
		"energy_saved": 10
	}],
	"energy_losses": [{
		"label": "Drzwi",
		"percent": 2
	},{
		"label": "Ściany zewnętrzne",
		"percent": 3
	},{
		"label": "Podłoga parteru",
		"percent": 8
	},{
		"label": "Okna",
		"percent": 10
	},{
		"label": "Wentylacja",
		"percent": 17
	},{
		"label": "Dach",
		"percent": 60
	}]
}
            

Listy materiałów

GET https://cieplo.app/api/materials/{field}

Gdzie field to nazwa pola, w którym lista materiałów jest wykorzystywana, dla którego ma być zwrócona lista odpowiednich materiałów (dla każdego z pól lista materiałów jest/może być inna).

{
	"123": "Styropian",
	"125": "Wełna mineralna",
	"129": "Słoma"
}
            

Informacje o aktualnej subskrypcji

GET https://cieplo.app/api/subscription

Odpowiedź, gdy konto posiada aktywną subskrypcję:

{
	"level": "102",
	"status": "paid",
	"ends_at": "2025-01-21 06:58:46",
}
            

Odpowiedź w przypadku braku aktywnej subskrypcji:

{
}