Class OverkizConst

Namespace

OverKizApi

Assembly

OverKizApi.dll

Compile-time constants and server-endpoint descriptors used throughout the library.

public static class OverkizConst

Inheritance

object

OverkizConst

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

OAuth client IDs and secrets for Somfy and CozyTouch are intentionally public — they are embedded in the official mobile apps and are required for the standard OAuth 2.0 Resource Owner Password Credentials flow.

Fields

COZYTOUCH_ATLANTIC_API

Base URL of the Atlantic/CozyTouch identity API.

public const string COZYTOUCH_ATLANTIC_API = "https://apis.groupe-atlantic.com"

Field Value

string

COZYTOUCH_CLIENT_ID

Base64-encoded clientId:clientSecret credential used as the HTTP Basic Authorization header when exchanging credentials for an Atlantic OAuth token.

public const string COZYTOUCH_CLIENT_ID = "Q3RfMUpWeVRtSUxYOEllZkE3YVVOQmpGblpVYToyRWNORHpfZHkzNDJVSnFvMlo3cFNKTnZVdjBh"

Field Value

string

LOCAL_API_PATH

HTTP path prefix appended to the gateway's local IP address to reach the developer-mode local API (e.g. https://<gateway-ip>:8443/enduser-mobile-web/1/enduserAPI/).

public const string LOCAL_API_PATH = "/enduser-mobile-web/1/enduserAPI/"

Field Value

string

LOCAL_API_PORT

HTTPS port used by the Overkiz local developer-mode API.

public const int LOCAL_API_PORT = 8443

Field Value

int

NEXITY_API

Base URL of the Nexity cloud API.

public const string NEXITY_API = "https://api.egn.prd.aws-nexity.fr"

Field Value

string

NEXITY_COGNITO_CLIENT_ID

AWS Cognito app client ID for the Nexity user pool.

public const string NEXITY_COGNITO_CLIENT_ID = "3mca95jd5ase5lfde65rerovok"

Field Value

string

NEXITY_COGNITO_REGION

AWS region that hosts the Nexity Cognito user pool.

public const string NEXITY_COGNITO_REGION = "eu-west-1"

Field Value

string

NEXITY_COGNITO_USER_POOL

AWS Cognito user pool ID used for Nexity SRP authentication.

public const string NEXITY_COGNITO_USER_POOL = "eu-west-1_wj277ucoI"

Field Value

string

REXEL_BACKEND_API

Base URL of the Rexel Overkiz-proxy backend used for gateway-scoped device requests.

public const string REXEL_BACKEND_API = "https://econnect-api.rexelservices.fr/api/enduser/overkiz/"

Field Value

string

REXEL_ENDUSER_API

Base URL of the Rexel end-user directory API used to enumerate homes and gateways.

public const string REXEL_ENDUSER_API = "https://econnect-api.rexelservices.fr/api/enduser"

Field Value

string

REXEL_GATEWAY_HEADER

Name of the HTTP header required by Rexel to scope requests to a selected gateway.

public const string REXEL_GATEWAY_HEADER = "gatewayId"

Field Value

string

SOMFY_API

Base URL of the Somfy identity / OAuth 2.0 server.

public const string SOMFY_API = "https://accounts.somfy.com"

Field Value

string

SOMFY_CLIENT_ID

Somfy OAuth 2.0 client ID embedded in the official Somfy TaHoma mobile app. This value is public by design.

public const string SOMFY_CLIENT_ID = "0d8e920c-1478-11e7-a377-02dd59bd3041_1ewvaqmclfogo4kcsoo0c8k4kso884owg08sg8c40sk4go4ksg"

Field Value

string

SOMFY_CLIENT_SECRET

Somfy OAuth 2.0 client secret embedded in the official Somfy TaHoma mobile app. This value is public by design (required for ROPC flow).

public const string SOMFY_CLIENT_SECRET = "12k73w1n540g8o4cokg0cw84cog840k84cwggscwg884004kgk"

Field Value

string

ServersWithLocalApi

The subset of Server values whose gateways support the local developer-mode API. When the selected server is in this list, a local bearer token can be used instead of cloud credentials to communicate directly with the gateway on the LAN.

public static readonly IReadOnlyList<Server> ServersWithLocalApi

Field Value

IReadOnlyList<Server>

SupportedServers

Maps every known Server key to its OverkizServer endpoint descriptor. Pass the value obtained from this dictionary directly to the OverkizClient constructor.

public static readonly IReadOnlyDictionary<Server, OverkizServer> SupportedServers

Field Value

IReadOnlyDictionary<Server, OverkizServer>

Methods

CreateLocalHttpClientHandler()

Creates an HttpClientHandler suitable for connecting to a local Overkiz gateway. The handler bypasses TLS certificate validation because local gateways use a self-signed certificate. The caller is responsible for disposing both the handler and the HttpClient built from it.

public static HttpClientHandler CreateLocalHttpClientHandler()

Returns

HttpClientHandler

LocalEndpoint(string)

Builds the full local API endpoint URL for the given gateway IP or hostname.

public static string LocalEndpoint(string gatewayIp)

Parameters

gatewayIp string

Returns

string

LocalServer(string)

Creates an OverkizServer descriptor for a local gateway connection.

public static OverkizServer LocalServer(string gatewayIp)

Parameters

gatewayIp string

Returns

OverkizServer