Ampcontrol API (2.0.0)

Ampcontrol's API powers its smart charging software. Behind this API is a software layer optimizing charging stations, charging networks, and electric fleets around the world to allow more electric vehicles on our roads, globally. Ampcontrol, for example, provides a REST API for load management, electric fleet charging, and public charging networks. With this API, you can connect Ampcontrol to any existing software system. Ampcontrol's resources have one or more methods that can be used over HTTP, like GET, POST, PATCH, and DELETE.

Ampcontrol supports HTTP Bearer authentication. This allows you to protect the URLs on your web server so that only you and Ampcontrol can access them. In order to authenticate, you will use your Ampcontrol authentication token: Authorization: Bearer <token>

Let's do one simple API request with Ampcontrol. The code below shows how to create a new charging session. This will in turn create an optimization.

# example API request
import requests
import json
# You should have received your Bearer Token from our team
token = 'your_bearer_token'
headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}
# If you don't have chargePoints or connectors, you can use the API to create new ones
payload = {
  "chargePointId": "7f761661-39fc-5220-b167-dc550d9ad06c",
  "connectorId": "9c82883b-694e-5e10-bfc2-be7f88f376ce",
}
url = "https://api.ampcontrol.io/v2/charging_sessions/"
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=4))

# example API response {
  "status": "success",
  "data": [
    {
      "id": "e92f5fb6-e014-5267-9f3e-41cd72248f89",
      "created": "2021-07-09T18:08:52.649578+00:00",
      "updated": "2021-07-09T18:08:52.649578+00:00",
      "connectorId": "9c82883b-694e-5e10-bfc2-be7f88f376ce",
      "chargingRateUnit": "kW",
      "vehicleId": null,
      "transactionId": null,
      "energyToCharge": null,
      "maximumChargingTimeDate": null,
      "maxChargingPowerOfVehicle": null,
      "chargePointId": "7f761661-39fc-5220-b167-dc550d9ad06c"
    }
  ],
  "total": 1
}

Webhooks are user-defined HTTP callbacks triggered by an event in a web application. Ampcontrol uses webhooks to asynchronously let your application know when optimizations happen, like getting a new charging profile for your vehicle. This is optional, and you can use Ampcontrol also without using webhooks. When the webhook event occurs, Ampcontrol makes a POST request to the URL you have configured for your webhook. Ampcontrol’s request to your application includes details of the event, like kilowatt limits for a certain charge point connector. Your application can then perform whatever logic is necessary. Webhook requests are signed with an X-Webhook-Signature HTTP header containing the HMAC sha256 digest output of your network's webhookSecret and the request body. This way you can optionally use the header to verify that the request comes from a trusted source. The User-Agent header is set to Ampcontrol Delivery Service, firewall rules can be added to allow inbound requests containing this header on the client-side.

How to validate requests sent to the webhook URL from our delivery service, an example:

webhook_secret = 'my-secret-token' # this can be set on /v2/networks/ endpoint
headers = response.header
body = response.body
print(body)
"""
  {
      'this is a simple json reponse payload'
  }
"""
print(headers)
""" {
  "User-Agent": "Ampcontrol Delivery Service"
  "X-Webhook-Signature": "676851448a4cda2f3c285ed2274867654c801e8a6394c351b77c713ab4ad20e4"
} """
# to validate that the payload was sent by ampcontrol we can do the following:
signature = hmac.create(
    key=webhook_secret.encode("UTF-8"),
    msg=body.enconde("UTF-8"),
    hash_function=sha256
)
# Make sure that the HMAC library you are using returns as a string containing only hexadecimal digits.
assert signature == headers["X-Webhook-Signature"]

Ampcontrol works with digital twins of a charging network or charging location. The system differentiates the following objects: Networks, chargePoints, connectors, chargingSessions, optimizations, and vehicles (optional).

Integrating Ampcontrol into your app is simple, and you can follow these steps:

1. Test your token
   
2. Post a new network
   
3. Post a charge point
   
4. Post a connector
   
5. Post ("start") a charging session
   
6. Get optimization results
   
7. Post meter values
   
8. Delete ("stop") a charging session
   
9. Post a vehicle
   
10. Update vehicle
    
11. Post/start a charging session with vehicle data
    
12. Set a webhook for a network
    

To check that your integration is working correctly, make a test API request using your test token to get all your charge points.

# replace the token with your token
headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}
url = "https://api.ampcontrol.io/v2/charge_points/"
response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a "success". If you haven't created any charge points, the data will be empty.

{
  "status": "success",
  "data": [],
  "total": 0
}

Before using Ampcontrol, you typically have to create a new network, charge point, and connector. In this step, we create a network, using only the required data.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}

payload = {
  "name": "my first network",
  "maxCapacity": 30  # maxCapacity of networks is always in kW
}
url = "https://api.ampcontrol.io/v2/networks/"
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a network object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "maxCapacity": 30.0,
      "currentChargingLoad": null,
      "name": "my first network",
      "id": "3b87971f-e7ec-5a73-be26-cee0aafe75fe",
      "created": "2021-07-10T17:21:33.462196+00:00",
      "updated": "2021-07-10T17:21:33.462196+00:00",
      "objective": "load_sharing",
      "timeZone": "UTC",
      "location": null,
      "webhook": null,
      "currentLimit": null
    }
  ],
  "total": 1
}

In this step, we create a charge point and a connector, using only the required data. The charge point is linked to your network.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}

payload = {
  "maxCapacity": 75, # maxCapacity of charge point is always in kW
  "name": "Charger 1",
  "networkId": "3b87971f-e7ec-5a73-be26-cee0aafe75fe" # the charge point is linked to the networkId
}
url = "https://api.ampcontrol.io/v2/charge_points/"
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a chargePoint object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "id": "42e56909-f84f-5852-a7ad-98f284104af4",
      "created": "2021-07-10T17:27:08.404196+00:00",
      "updated": "2021-07-10T17:27:08.404196+00:00",
      "maxCapacity": 75.0,
      "currentChargingLoad": 0.0,
      "name": "Charger 1",
      "networkId": "3b87971f-e7ec-5a73-be26-cee0aafe75fe",
      "location": null,
      "latitude": null,
      "longitude": null,
      "vendor": null,
      "protocol": null,
      "active": false,
      "currentLimit": null
    }
  ],
  "total": 1
}

In this step, we create a connector, using only the required data. The connector is linked to your charge point.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}

payload = {
  "maxCapacity": 75, # maxCapacity of connectors is always in kW
  "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4", # the connector is linked to the chargePointId
  "connectorId": 1,  # connectorId is an integer >0
  "currentType": "DC", # currentType can be DC, AC_phase3_LN, or AC_phase3_LL
  "voltage": 230 # Minimum voltage is 120V
}
url = "https://api.ampcontrol.io/v2/connectors/"
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a connector object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "maxCapacity": 75.0,
      "currentChargingLoad": 0.0,
      "name": null,
      "id": "c77a41a0-be89-58a6-867b-5d61b04f2d22",
      "created": "2021-07-10T17:32:15.059072+00:00",
      "updated": "2021-07-10T17:32:15.059072+00:00",
      "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4",
      "connectorId": 1,
      "currentType": "DC",
      "voltage": 230.0,
      "powerFactor": 1.0,
      "active": false,
      "currentLimit": null
    }
  ],
  "total": 1
}

In this step, we create a charging session on the created connector, using only the required data.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}
# the charging session is linked to charge point and connector
payload = {
  "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4",
  "connectorId": "c77a41a0-be89-58a6-867b-5d61b04f2d22"
}
url = "https://api.ampcontrol.io/v2/charging_sessions/"
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a chargingSession object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "id": "066dad20-d289-560b-9b67-fd9bb9f52057",
      "created": "2021-07-10T17:40:40.898007+00:00",
      "updated": "2021-07-10T17:40:40.898007+00:00",
      "connectorId": "c77a41a0-be89-58a6-867b-5d61b04f2d22",
      "chargingRateUnit": "kW",
      "vehicleId": null,
      "transactionId": null,
      "energyToCharge": null,
      "maximumChargingTimeDate": null,
      "maxChargingPowerOfVehicle": null,
      "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4"
    }
  ],
  "total": 1
}

In this step, we receive optimization results for the created charging session.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}
# Use the query parameter to filter by network, chargepoint, connector, or charge_session
url = "https://api.ampcontrol.io/v2/optimizations/?network=3b87971f-e7ec-5a73-be26-cee0aafe75fe"
response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns an Optimization object in the response of your API request. In this case, the network is the limiting factor and the optimization allows 30 kW.

{
  "status": "success",
  "data": [
    {
      "id": "b87ecec4-5805-50d3-ac62-f75da4138e70",
      "created": "2021-07-10T17:40:40.970125+00:00",
      "updated": "2021-07-10T17:40:40.970125+00:00",
      "method": "load_sharing",
      "csChargingProfiles": {
        "chargingProfileId": 12962,
        "chargingProfileKind": "Absolute",
        "chargingProfilePurpose": "TxProfile",
        "chargingSchedule": {
          "chargingRateUnit": "kW",
          "chargingSchedulePeriod": [
            {
              "limit": 30.0,
              "startPeriod": 0.0
            },
            {
              "limit": 30.0,
              "startPeriod": 900.0
            },
            {
              "limit": 30.0,
              "startPeriod": 1800.0
            },
            {
              "limit": 30.0,
              "startPeriod": 2700.0
            },
            {
              "limit": 30.0,
              "startPeriod": 3600.0
            },
            {
              "limit": 30.0,
              "startPeriod": 4500.0
            },
            {
              "limit": 30.0,
              "startPeriod": 5400.0
            },
            {
              "limit": 30.0,
              "startPeriod": 6300.0
            },
            {
              "limit": 30.0,
              "startPeriod": 7200.0
            },
            {
              "limit": 30.0,
              "startPeriod": 8100.0-
            }
          ],
          "duration": 9000.0
        },
        "stackLevel": 0.0,
        "transactionId": null,
        "validFrom": "2021-07-10T17:40:40.970125+00:00",
        "validTo": "2021-07-10T20:10:40.970125+00:00"
      },
      "profile": {
        "start": "2021-07-10T17:40:40.970125+00:00",
        "stop": "2021-07-10T20:10:40.970125+0-0:00",
        "unit": "kW",
        "data": [
          {
            "time": "2021-07-10T17:40:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T17:55:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T18:10:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T18:25:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T18:40:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T18:55:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T19:10:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T19:25:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T19:40:40.970125+00:00",
            "value": 30.0
          },
          {
            "time": "2021-07-10T19:55:40.970125+00:00",
            "value": 30.0
          }
        ]
      },
      "connectorId": 1,
      "connector": "c77a41a0-be89-58a6-867b-5d61b04f2d22",
      "chargepointId": "42e56909-f84f-5852-a7ad-98f284104af4",
      "networkId": "3b87971f-e7ec-5a73-be26-cee0aafe75fe"
    }
  ],
  "total": 1
}

Your dashboard will show the load profile.

In this step, we send a meter value from the connector to Ampcontrol. Ampcontrol uses meter values to confirm and adjust the optimization dynamically.

  headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
  }

  payload = {
    "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4",
    "connectorId": 1,
    "meterValues": [
        {
            "sampledValue": [
                {
                    "context": "Sample.Periodic",
                    "format": "Raw",
                    "location": "Outlet",
                    "measurand": "Energy.Active.Import.Register",
                    "phase": "L1",
                    "unit": "Wh",
                    "value": 56790
                }
            ],
            "timestamp": "2021-07-10T17:40:56+00:00"
        }
    ]
}
url = "https://api.ampcontrol.io/v2/meter_values/"
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a meterValue object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4",
      "connectorId": 1,
      "meterValues": [
        {
          "timestamp": "2021-07-10T17:40:56+00:00",
          "sampledValue": [
            {
              "context": "Sample.Periodic",
              "format": "Raw",
              "location": "Outlet",
              "measurand": "Energy.Active.Import.Register",
              "phase": "L1",
              "unit": "Wh",
              "value": 56790
            }
          ]
        }
      ]
    }
  ],
  "total": 1
}

In this step, we stop the same charging session. This is typically the step when the vehicle leaves the charge point.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}
# we use the charging session ID which Ampcontrol sent after the POST
url = "https://api.ampcontrol.io/v2/charging_sessions/066dad20-d289-560b-9b67-fd9bb9f52057"
response = requests.delete(url, headers=headers)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a chargingSession object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "id": "066dad20-d289-560b-9b67-fd9bb9f52057",
      "created": "2021-07-10T17:40:40.898007+00:00",
      "updated": "2021-07-10T20:25:30.749445+00:00",
      "connectorId": "c77a41a0-be89-58a6-867b-5d61b04f2d22",
      "chargingRateUnit": "kW",
      "vehicleId": null,
      "transactionId": null,
      "energyToCharge": null,
      "maximumChargingTimeDate": null,
      "maxChargingPowerOfVehicle": null,
      "chargePointId": "42e56909-f84f-5852-a7ad-98f284104af4"
    }
  ],
  "total": 1
}

In this step, we create a vehicle. All fields are optional. The vehicle is not related to a specific network and can be used across networks.

headers = {
        'content-type': 'application/json'
        'authorization': 'Bearer ' +  token
        }

payload = {
  "name": "Bus 2", # name can be defined by customer
  "VIN": "4Y1SL65848Z411439", # Vehicle identification number (VIN) is the identifying code for the vehicle
  "batteryCapacity": 100,  # batteryCapacity is always in kWh, is an integer >0
  "maxChargingPower": 11.5,  # maxChargingPower is in kW and defines the upper limit of the vehicle's power input
  "targetStateOfCharge": 100 # targetStateOfCharge is in percentage (%)
}
url = "https://api.ampcontrol.io/v2/vehicles/"
response = requests.post(url, headers=headers, data=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a Vehicle object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "name": "Bus 2",
      "id": "4e389086-efa1-57d4-981b-a63f25630cb8",
      "created": "2021-08-12T13:05:42.982026+00:00",
      "updated": "2021-08-12T13:05:42.982026+00:00",
      "VIN": "4Y1SL65848Z411439",
      "customerVehicleId": null,
      "stateOfCharge": 0.0,
      "targetStateOfCharge": 100.0,
      "maxChargingPower": 11.5,
      "batteryCapacity": 100.0,
      "location": null,
      "departureTime": null,
      "active": false
    }
  ],
  "total": 1
}

In this step, we update a vehicle. We send a target state of charge, the current state of charge and a departure time for the existing vehicle.

headers = {
        'content-type': 'application/json'
        'authorization': 'Bearer ' +  token
        }

payload = {
  "departureTime": "2020-08-13T06:00:00+00:00",  # departure time can be used for the next charging session
  "stateOfCharge": 15.5,  # previous targetStateOfCharge will be replaced
  "targetStateOfCharge": 90.0  # stateOfCharge can be updated also during the charging session
}
url = "https://api.ampcontrol.io/v2/vehicles/4e389086-efa1-57d4-981b-a63f25630cb8"  # we add the vehicleId int the URL
# we use the PATCH method
response = requests.patch(url, headers=headers, data=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns an updated Vehicle object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "name": "Bus 2",
      "id": "4e389086-efa1-57d4-981b-a63f25630cb8",
      "created": "2021-08-12T13:05:42.982026+00:00",
      "updated": "2021-08-12T13:15:24.175699+00:00",
      "VIN": "4Y1SL65848Z411439",
      "customerVehicleId": null,
      "stateOfCharge": 15.5,
      "targetStateOfCharge": 90.0,
      "maxChargingPower": 11.5,
      "batteryCapacity": 100.0,
      "location": null,
      "departureTime": "2020-08-13T06:00:00.000000+00:00",
      "active": false
    }
  ],
  "total": 1
}

In this step, we create a new charging session on the created connector, using vehicle data. This allows fleet optimizations. (note: the network's objective has to be set on "fleet" for this functionality).

headers = {
        'content-type': 'application/json'
        'authorization': 'Bearer ' +  token
        }

# the charging session is linked to charge point, connector, vehicle payload = {
  "chargePointId": "3121d5bc-e6b1-5fc0-baa2-a232e89d5b5c",
  "connectorId": "8b3041c7-6b7c-5c55-9d43-d3a0666dd40e",
  "vehicleId": "4e389086-efa1-57d4-981b-a63f25630cb8"
}
url = "https://api.ampcontrol.io/v2/charging_sessions/"
response = requests.patch(url, headers=headers, data=payload)
print(json.dumps(response.json(), indent=4))

Ampcontrol returns a chargingSession object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "id": "bb4f07b5-c419-5efd-9640-870729ae4be3",
      "created": "2021-08-12T13:23:30.736521+00:00",
      "updated": "2021-08-12T13:23:30.736521+00:00",
      "connectorId": "8b3041c7-6b7c-5c55-9d43-d3a0666dd40e",
      "chargingRateUnit": "kW",
      "vehicleId": "4e389086-efa1-57d4-981b-a63f25630cb8",
      "transactionId": null,
      "energyToCharge": null,
      "maximumChargingTimeDate": null,
      "maxChargingPowerOfVehicle": null,
      "chargePointId": "3121d5bc-e6b1-5fc0-baa2-a232e89d5b5c",
      "active": true,
      "sessionStart": "2021-08-12T13:23:30.757062+00:00",
      "sessionEnd": null
    }
  ],
  "total": 1
}

If you want optimization profiles to be sent via a POST request to an endpoint of your choice, you can set the network's webhook parameter when creating or updating the network (POST/PATCH). To avoid a malicious source from making requests to your webhook, an additional webhookSecret parameter must be provided. Webhook events are signed with an X-Webhook-Signature HTTP header. This string contains the HMAC sha256 digest output of your webhook secret and request body. One thing to keep in mind is that if the POST request to your webhook endpoint returns a 404 response, then the charging session associated with the optimization profiles will be ended.

headers = {
  'content-type': 'application/json',
  'authorization': 'Bearer ' +  token
}


payload = {
  "webhook": "https://example.com/custom-webhook/"
  "webhookSecret": "some-secret-string"
}

url = "https://api.ampcontrol.io/v2/networks/3b87971f-e7ec-5a73-be26-cee0aafe75fe"

response = requests.patch(url, headers=headers, json=payload)

print(json.dumps(response.json(), indent=4))

Ampcontrol then returns the updated network object in the response of your API request.

{
  "status": "success",
  "data": [
    {
      "maxCapacity": 30.0,
      "currentChargingLoad": null,
      "name": "my first network",
      "id": "3b87971f-e7ec-5a73-be26-cee0aafe75fe",
      "created": "2021-07-10T17:21:33.462196+00:00",
      "updated": "2021-07-10T17:21:33.462196+00:00",
      "objective": "load_sharing",
      "timeZone": "UTC",
      "location": null,
      "webhook": "https://example.com/custom-webhook/"
      "currentLimit": null
    }
  ],
  "total": 1
}

ABOUT CONFIGURATION'S SETUP

We use both query parameters and json body to use the available endpoints, and at each level (customer, network and chargepoint level) we expect different behaviours.

1. Customer level:

Whenever using v2/configurations/?customer={customer_uuid}, inside the data component of the response, we expect to get the fields deliveryOptions, integrations and ampCmsOptions, in the following structure by default:

  {
      "deliveryOptions": {
          "presets": {
              "TxProfile": {
                  "ampcontrol-default-TxProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 2,
                          "numberPhases": false,
                          "chargingRateUnit": null,
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "All",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxProfile"
                      },
                      "isDefault": true
                  },
                  "ampcontrol-squential-TxProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 2,
                          "numberPhases": false,
                          "chargingRateUnit": null,
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "Sequential",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxProfile"
                      },
                      "isDefault": false
                  },
                  "ampcontrol-sequential-ampere-TxProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 2,
                          "numberPhases": false,
                          "chargingRateUnit": "A",
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "Sequential",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxProfile"
                      },
                      "isDefault": false
                  },
                  "ampcontrol-default-TxProfile-number-phases": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 2,
                          "numberPhases": true,
                          "chargingRateUnit": null,
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "All",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxProfile"
                      },
                      "isDefault": false
                  },
                  "ampcontrol-sequential-ampere-number-phases-TxProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 2,
                          "numberPhases": true,
                          "chargingRateUnit": "A",
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "Sequential",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxProfile"
                      },
                      "isDefault": false
                  }
              },
              "TxDefaultProfile": {
                  "ampcontrol-default-TxDefaultProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 1,
                          "numberPhases": false,
                          "chargingRateUnit": null,
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "All",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxDefaultProfile"
                      },
                      "isDefault": true
                  },
                  "ampcontrol-squential-TxDefaultProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 1,
                          "numberPhases": false,
                          "chargingRateUnit": null,
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "Sequential",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxDefaultProfile"
                      },
                      "isDefault": false
                  },
                  "ampcontrol-sequential-ampere-TxDefaultProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 1,
                          "numberPhases": false,
                          "chargingRateUnit": "A",
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "Sequential",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxDefaultProfile"
                      },
                      "isDefault": false
                  },
                  "ampcontrol-default-TxDefaultProfile-number-phases": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 1,
                          "numberPhases": true,
                          "chargingRateUnit": null,
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "All",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxDefaultProfile"
                      },
                      "isDefault": false
                  },
                  "ampcontrol-sequential-ampere-number-phases-TxDefaultProfile": {
                      "settings": {
                          "timeZone": "utc",
                          "stackLevel": 1,
                          "numberPhases": true,
                          "chargingRateUnit": "A",
                          "timestampsFormat": "default",
                          "useTransactionId": true,
                          "limitDeliveryType": "Sequential",
                          "chargingProfileKind": "Absolute",
                          "useChargingProfileId": true,
                          "chargingProfilePurpose": "TxDefaultProfile"
                      },
                      "isDefault": false
                  }
              }
          },
          "TxProfile": "ampcontrol-default-TxProfile",
          "TxDefaultProfile": "ampcontrol-default-TxDefaultProfile"
      },
      "integrations": {},
      "ampCmsOptions": {
          "feature": "off",
          "secret": "unregistered",
          "targetCmsUrl": null,
          "defaultNetworkId": null
      }
  }

• For deliveryOptions: Contains the the pre-defined configurations to which the other elements in further levels (network or chargepoint) will refer to when declaring the TxProfile and TxDefaultProfile. Inside deliveryOptions->presets you will find a isDefault boolean key that indicates if for all the further levels of configurations, this specific profile will be applied by default, in case no particular configuration is specified, once again, in further levels.

• For integrations: Contains the integration(s) info that this particular customer (or simmilarly for network and chargepoint) have.

• For ampCmsOptions: Contains the authentication and usage specifications for a connection stablished through the AmpCMS service

2. Network level:

From using v2/configurations/?network={network_uuid} we expect a response like:

{
      "alerts": true,
      "idTagPriority": false,
      "integrations": {
          "shelly": {
              "base_url": "https://www.dummy-url.com",
              "device_id": "DEVICE_ABC",
              "auth_key": "my-auth-key"
          },
          "longship": {
              "base_url": "https://www.dummy-url.com",
              "tenant_key": {
                  "key": "Ocp-Apim-Subscription-Key",
                  "value": "dummyTenantKey"
              },
              "api_key": {
                  "key": "x-api-key",
                  "value": "dummyAPIKey"
              }
          }
      },
      "deliveryOptions": {
          "TxProfile": "ampcontrol-default-TxProfile",
          "TxDefaultProfile": "ampcontrol-default-TxDefaultProfile"
      },
      "chargingRules": null,
      "alertOptions": {
          "callError": {
              "enabled": true,
              "urgency": "High",
              "category": ["List", "of", "categories"],
              "notifications": {
                  "enabled": false
              },
              "description": "This is a description of the alert.",
              "action": "Suggested action to take"
          }
      }
  }

• alerts sets the boolean that toggles on/off alerts
• ìdTagPriority ...
• integrations contains the integration authentication details of our partners
• deliveryOptions, just as explained above for customers, points to a specific configuration set by its name, depending of the profile type that it refers to. If no specific type is set, the endpoint should return an empty string:

"deliveryOptions": {
    "TxProfile": "",
    "TxDefaultProfile": "",
}

• chargingRules ...
• alertOptions Contains the configuration for alerts and notification, Example:

"alertOptions": {
  "callError": {
    "enabled": true,
    "urgency": "High",
    "category": ["List", "of", "categories"],
    "notifications": {
        "enabled": false
    },
    "description": "This is a description of the alert.",
    "action": "Suggested action to take"
  }
}

3. Chargepoint level:

Using v2/configurations/?chargepoint={chargepoint_uuid} sets the configuration of the following fields:

{
  "deliveryOptions": {
      "TxProfile": "ampcontrol-default-TxProfile",
      "TxDefaultProfile": "ampcontrol-default-TxDefaultProfile"
  }
}

Similar to the network's level of configuration

4. User level:

Finally, use ``2/configurations/?user={user_uuid}` to set the configuration of the following fields:

{
  "notificationChannels": {
    "smsNotifications": false,
    "emailNotifications": false
  }
}