> ## Documentation Index
> Fetch the complete documentation index at: https://docs.datanumia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

Recometrics API is based on HTTPS, REST API, OpenAPI and OAuth2.

## Portofolio

This API has a portfolio of energy equipments and services that you could recommend to your end-users:

* Solar panels

* Air / water heat pumps

* Air / air heat pumps

* Mechanical ventilation systems

* Electric vehicles

* Electric vehicle supply equipment

* Insulate joineries

* Insulate roof

* Insulate walls

## Parameters

Some key parameters and figures are returned through this API for a given end-user and a given energy equipment / service :

**Eligibility parameter:**

* True if that energy equipment / service is relevant for her / him

* False otherwise

**Interest score :** A score between 0 and 1 quantifying how likely he / she is to invest in that energy equipment / service

**End-user benefits :** Various estimated benefits for him / her after investing in that energy equipment / service :

* Energy and money savings / earnings

* CO2 footprint reduction

* Key investment figures :

* Investment cost

* Amortization period

To run these simulations, multiple data sources are exploited :

* Open data (ex : weather data)

* End-user profile data (ex : owner / renter)

* Energy consumption data (ex : last year gas consumption)

These data are either **manually provided** by the end user, **calculated**, collected from the provider databases or from open data sources.

## Security

Recometrics uses AWS Cognito, API Gateway and Spring Security to manage access for B2C and B2B customers. B2C customers authenticate through OAuth2 Authorization Code Grant with PKCE, while B2B customers use OAuth2 Client Credentials. API Gateway validates JWT tokens and Spring Security backend ensures fine-grained access control. Internal modules access the API through a NAT Gateway. Spring Security also handles authentication of outgoing calls to external APIs.