Monta
Monta API
Monta API

Charge Point Integrations

Retrieve a list of charge points integrations

GET
https://partner-api.monta.com
/api/v1/charge-point-integrations

Required scope: charge-points:read.
Organization authorization: supported

Retrieve a list of charge points integrations › query Parameters

chargePointId
​integer · int64 · required

Allows to filter list of charge points integrations by a charge point id

Example: 30
page
​integer · int32

page number to retrieve (starts with 0)

Default: 0
perPage
​integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10
includeDeleted
​boolean | null

Includes deleted resources in the response

Example: true

Retrieve a list of charge points integrations › Responses

List of charges points integrations that match the criteria

OffsetBasedResponse_10
​ChargePointIntegration[] · required
​MontaPage.Meta · required

Create or update a charge point integration

PUT
https://partner-api.monta.com
/api/v1/charge-point-integrations

Note: This endpoint will create or update an existing integration,meaning that the existing integration will be replaced by a new one
Required scope: charge-points:write.
Organization authorization: supported

Create or update a charge point integration › Request Body

CreateOrUpdateChargePointIntegration
chargePointId
​integer · int64 · required

Id of the charge point to setup the integration

Example: 13
chargePointModelId
​integer · int64 · required

Id of the charge point model to be integrated

Example: 20
serialNumber
​string · minLength: 1 · required

The serial number for the charge point integration

Example: 46964534
connectorId
​integer | null · int32

Connector id for the charge point integration. when null the connectorId will default to 1

Example: 1
autoConnect
​boolean | null

Indicates that an attempt to connect the charge point should happen, when autoConnect is set to true the Charge Point needs to point to Monta (via OCPP websocket)

Note: when false the integration will be create but the state will be to pending

Example: true
Default: true
ocppPassword
​string | null

Basic authentication password that will be required for the OCPP websocket connection. Gets ignored, i.e. does not clear the password, when null

Example: hunter2

Create or update a charge point integration › Responses

Charge point integration created/updated

ChargePointIntegration
state
​string · enum · required

The current state of the charge point integration

Enum values:
pending
connected
disconnected
error
unknown
Example: connected
serialNumber
​string · required

The serial number of this charge point integration

Example: 46964534
chargePointIdentity
​string · required

The identity number of this charge point integration

Example: 46964534
integrationTypeIdentifier
​string · required

The integration type (method) used

Example: ocpp
​object · required

The charge point associated to this integration

createdAt
​string · date-time · required

The Creation date of this charge point integration

Example: 2022-05-12T15:56:45.99Z
id
​integer · int64

The id of this charge point integration

Example: 1
connectorId
​integer | null · int32

The connector id for this charge point integration

Example: 1
activeAt
​string | null · date-time

The Date this charge point integration was set to active

Example: 2022-05-12T15:56:45.99Z
updatedAt
​string | null · date-time

The Date this charge point integration was last updated

Example: 2022-05-12T16:56:45.99Z
deletedAt
​string | null · date-time

The Date this charge point integration was deleted

Example: 2022-05-12T16:56:45.99Z

Retrieve a single charge point integration

GET
https://partner-api.monta.com
/api/v1/charge-point-integrations/{chargePointIntegrationId}

Required scope: charge-points:read.
Organization authorization: supported

Retrieve a single charge point integration › path Parameters

chargePointIntegrationId
​integer · int64 · required

Retrieve a single charge point integration › Responses

Charge point integration with provided id

ChargePointIntegration
state
​string · enum · required

The current state of the charge point integration

Enum values:
pending
connected
disconnected
error
unknown
Example: connected
serialNumber
​string · required

The serial number of this charge point integration

Example: 46964534
chargePointIdentity
​string · required

The identity number of this charge point integration

Example: 46964534
integrationTypeIdentifier
​string · required

The integration type (method) used

Example: ocpp
​object · required

The charge point associated to this integration

createdAt
​string · date-time · required

The Creation date of this charge point integration

Example: 2022-05-12T15:56:45.99Z
id
​integer · int64

The id of this charge point integration

Example: 1
connectorId
​integer | null · int32

The connector id for this charge point integration

Example: 1
activeAt
​string | null · date-time

The Date this charge point integration was set to active

Example: 2022-05-12T15:56:45.99Z
updatedAt
​string | null · date-time

The Date this charge point integration was last updated

Example: 2022-05-12T16:56:45.99Z
deletedAt
​string | null · date-time

The Date this charge point integration was deleted

Example: 2022-05-12T16:56:45.99Z

Delete a charge point integration

DELETE
https://partner-api.monta.com
/api/v1/charge-point-integrations/{chargePointIntegrationId}

Required scope: charge-points:delete.
Organization authorization: supported

Delete a charge point integration › path Parameters

chargePointIntegrationId
​integer · int64 · required

Delete a charge point integration › Responses

Charge point integration deleted

No data returned
Charge Point ConnectorsCharge Point Models