Skip to content

Authentication

Access to the Customer Service API must be enabled for the user's live API key by the n3rgy data backoffice.

All endpoints requests are authenticated via the x-api-key header param, which must contain the user's API key that must be a valid one.

Retrieve Consented MPxNs

This endpoint requests are only authenticated by x-api-key.

If the authentication fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Retrieve Available Utilities

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of consent status:

  • User must have for the HAN, specified with the given MPxN, an active consent.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Retrieve Reading Types

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of consent status:

  • User must have for the HAN, specified with the given MPxN, an active consent.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Set Meter Update Frequency

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of customer's authorization to change update frequencies and consent status:

  • User must be allowed to change update frequencies.

  • User must have for the HAN, specified with the given MPxN, an active consent.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Find MPxN, Retrieve MPxN availability

This endpoint requests are only authenticated by x-api-key.

If the authentication fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Find MPxN, Retrieve Address availability

This endpoint requests are only authenticated by x-api-key.

If the authentication fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Get Update Frequencies, Retrieve Data Update Frequencies

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of consent status:

  • User must have for the HAN, specified with the given MPxN, an active consent.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Retrieve Data for Reading Type

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of consent status:

  • User must have for the HAN, specified with the given MPxN, an active consent.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Set Defaults

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of customer's authorization to change update frequencies:

  • User must be allowed to change update frequencies.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Reset Update Frequencies for all consented HANs

This endpoint requests are not only authenticated via the x-api-key header param, but also by verification of customer's authorization to change update frequencies:

  • User must be allowed to change update frequencies.

If any of these authentication rules fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Read Inventory

This endpoint requests are only authenticated by x-api-key.

If the authentication fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Update Now

This endpoint requests are only authenticated by x-api-key, but also by verification of consent status:

  • User must have for the HAN, specified with the given MPxN, an active consent.

If the authentication fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).

Push Notifications

This endpoint requests are only authenticated by x-api-key:

If the authentication fail then a Forbidden response with a 403 status code is returned (see Error scenarios for the specific messages).