HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog
Terms of Use

Release Notes: Public API 2.123.0

10 months ago by Valentin Alexiev
  1. Add durationFeeFrom and durationFeeTo to:
    1. the payload of TariffChangedNotification notification, Notifications / Subscribe
    2. pricing object of tariffs:
      1. Tariffs / Listing
      2. Tariffs / Create
      3. Tariffs / Read
      4. Tariffs / Update
      5. Tariff Snapshot / Read

Release Notes: Public API 2.122.0

10 months ago by Valentin Alexiev
  1. Add more measurands to the payload of SessionMeterValuesNotification webhook, Notifications / Subscribe
    1. Current.Import
    2. Current.Offered
    3. Energy.Active.Import.Register
    4. Power.Offered
    5. Temperature
    6. Voltage
  2. Change the endpoint of Charge Point Models to
    /public-api/resources/charge-point-models/v1.0/
  3. Change the endpoint of Charge Point Vendors to
    /public-api/resources/charge-point-vendors/v1.0
  4. Add evsePhysicalReference property to filter object of Charge Points / Listing to get EVSE by physical reference (e.g. from QR code). Remove physicalReference property.

Release Notes: Public API 2.121.0

11 months ago by Valentin Alexiev
  1. Notifications:
    1. Create a new webhook when CDR Received, Notifications / Subscribe
    2. Add user id and email to the payload of the partnerInvite.changed notification, Notifications / Subscribe
    3. Add meterStart and meterStop to the payload of the SessionStartStopNotification notification, Notifications / Subscribe
  2. Circuits:
    1. Add support for electricity meters to circuits, Circuits / Create
    2. Add user priorities for using a circuit, Circuits / User Priorities / Create
  3. Add possibility to start a session without EVSE ID, Actions / Start Charging Session Without EVSE
  4. Rename applyToUsersOfChargePointOwner to applyToUsersOfChargePointPartner in restrictions of a tariff, Tariffs / Create
  5. Add EVSE status to the roaming object, Charge Point / EVSEs / Listing

Release Notes: Public API 2.120.0

11 months ago by Valentin Alexiev
  1. Implement pagination support for sessions history, Sessions / Listing
    • page
      integer
      The page number to fetch (defaults to 1). Not used in cursor pagination.
    • per_page
      integer
      The numbers of items to return. Used in both page and cursor pagination to declare the page size.

Release Notes: Public API 2.119.0

11 months ago by Valentin Alexiev
  1. Add array of tags to the resource Charge Point in the response and as filter.
    1. Add tags array when creating a Charge Point, Charge Points / Create
    2. Filter a list of Charge points by a tag Charge Points / Listing
    3. Update tags of a Charge Point, Charge Points / Update
    4. Tags are included in the response of getting a Charge Point, Charge Points / Read

Release Notes: Public API 2.118.0

11 months ago by Svetoslav Mitov
  1. Remove Error 422 from Sessions / Read endpoint - The payload you provided is invalid.
    Not relevant to GET methods.
  2. Add new revenue sharing parameters to Resource / Partner Contracts
    • fixedFeePerSessionAc
      number or NULL
      Description: Additional flat fee that is applied for every billed session and subtracted from the Partner’s share of the revenue for each session on AC Charging Station. This fee is available only if the feature "Additional Platform Fees" is enabled for the system.
    • fixedFeePerSessionDc
      number or NULL
      Description: Additional flat fee that is applied for every billed session and subtracted from the Partner’s share of the revenue for each session on DC Charging Station. This fee is available only if the feature "Additional Platform Fees" is enabled for the system.
    • feePerKwhAc
      number or NULL
      Description:Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on AC Charging Station. This fee is available only if the feature "Additional Platform Fees" is enabled for the system.
    • feePerKwhDc
      number or NULL
      Description: Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on DC Charging Station. This fee is available only if the feature "Additional Platform Fees" is enabled for the system.
    • handlingFee
      number or NULL
      Description: Additional percentage fee to be applied on the total amount paid by the user for the session. This fee is then subtracted from the Partner's share of the revenue. This fee is available only if the feature "Additional Platform Fees" is enabled for the system.
  3. Replace Security Event Log endpoint names:
    • /public-api/resources/security-events-log/v2.0 changed to /public-api/resources/security-events/v2.0
    • /public-api/resources/security-events-log/v2.0/{securityEventLog} changed to /public-api/resources/security-events/v2.0/{securityEvent}
  4. Option to enforce users to reset password at next login
    • The functionality to enforce EV Driver users to follow the Password Reset process at next login has been introduced to AMPECO's backend. It is also introduced for the Public API:
      • resource / user [POST, PATCH]
        • requirePasswordReset - optional
          boolean
          Description: Sets a requirement for the user to set a new password when they next open the app. After a new password is set, this option resets automatically.

Release Notes: Public API 2.117.0

12 months ago by Svetoslav Mitov
  1. Introduce Locations v2.0 resource
    1. Properties:
      • id - readonly
        integer
      • name - required
        string
      • status - required
        enum
      • shortDescription - optional, translatable
        array or NULL
      • description - optional, translatable
        array or NULL
      • additionalDescription - optional, translatable
        array or NULL
      • locationImage - optional, readonly
      • images - optional, readonly
      • geoposition - required
        • latitude - required
          float
        • longitude - required
          float
      • address - required
        translatable
      • city - required
        string
      • region - optional
        string
      • state - optional, conditional depending on country = US or AU
        string or NULL
      • country - required
        string
      • postCode - required
        string
      • workingHours - required
        array
        • isAlwaysOpen - required
          boolean
        • alwaysOpenForUserGroupIds - optional
          array of group ids
          required if isAlwaysOpen = false; otherwise NULL
        • stopSessionsOutsideWorkingHours - optional
          boolean
          required if isAlwaysOpen = false
        • hours - optional
      • chargingZones - required, readonly
        array
      • timezone - optional (only when multi timezone is enabled)
        string
      • externalId - optional
        string
      • lastUpdatedAt - required
        timestamp
  2. Expose Charging Zones endpoint in the API
    Supported Methods: GET, POST, PATCH, DELETE
    • Properties:
      • id
        integer
      • name - required
        string
        Description: Internal name of the Charging Zone. This isn't visible to end-users in the app.
        locationId - required
        integer
        Description: The ID of the Location, which the Charging Zone belongs to.
      • status - required
        string
        Description: Enum: "active" "disabled"
      • appAdditionalInfo - optional
        object
        Description: Additional information for the charging zone that is shown in the mobile app when the Location is viewed.
      • title - required
        object
        Description: Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.
      • description - required
        object
        Description: Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.
    • Filter
      • locationId

Release Notes: Public API 2.116.0

12 months ago by Svetoslav Mitov
  1. Add field receiptId to Sessions / Listing resource [GET]
    1. receiptId
      string
      Description: ID of the receipt that is issued for the charging session.
  2. Utilities resource created and exposed via Public API
    The Utility resource will serve the purpose of categorising Charging Stations per "Utility Provider" entity, furthering the current split "per country" and "per state" for reporting purposes.
    1. resource / utilities
      Supported Methods: GET, POST, PUT, DELETE
      1. id
        integer, required
      2. name
        string, required
      3. createdAt
        string, date-time, required
        Description: ISO 8601 formatted date
  3. Expose Optimised Dynamic Pricing tariff in public API
    1. Properties:
      1. thresholdPriceForEnergy - number, decimal
      2. priceForEnergyWhenOptimized - number, decimal
      3. pricePerKwh - number, decimal
      4. minPrice - number, decimal
      5. connectionFee - number, decimal
      6. taxID - number
      7. preAuthorizeAmount - number, decimal
  4. Postal Code is optional for country Israel (IL)

Release Notes: Public API 2.115.0

about 1 year ago by Svetoslav Mitov
  1. Fix: Smart Charging property set to "Disabled" by default when new Charge Point is created using Charge Point v2.0
  2. Fix: contractId is populated when declared in POST and PATCH requests for Charge Point v2.0
  3. Added circuitId to the Charge Point smartCharging object
    1. circuitId
      integer, optional, readonly
      Description: The ID of the DLM Circuit to which the charge point is added (if any).
  4. Enabled filtering by circuitId in Charge Points endpoint
    1. *circuitId
      integer
      Description: Only list charge points added to a certain DLM Circuit

Release Notes: Public API 2.114.0

about 1 year ago by Svetoslav Mitov
  1. Expose Firmware Update in action / charge point
    • PATH PARAMETERS
      chargePoint (required)
      integer
    • BODY SCHEMA
      url (required)
      string
      Description: Location (URL) from which to retrieve the firmware. retrieveAfter
      datetime
      Description: Specifies the date and time after which the Charge Point should retrieve the new firmware. If not provided, the current _datetime_ will be used.
      retries
      integer [0..10]
      Description: Specifies how many times the Charge Point must try to retrieve the (new) firmware before giving up.
      interval
      integer [0..3600]
      Description: The interval in seconds between each retry.
      signed (required)
      boolean
      Description: Indicates a Signed Firmware Update.
      signingCertificate
      string
      Description: Required if "signed" is true.
      signature
      string
      Description: Required if "signed" is true.