| Name | Authorization required | HTTP-methods allowed | Help text | Popularity (apistat) | Unit tests |
|---|---|---|---|---|---|
| AppView | GET | Returns either AppView for | 79833400 | 2 | |
| AppView/{app_version}/{gateway_id}/Refreshing | GET | Returns refresh status of gateway identified by {gateway_id} | 29478769 | ||
| AppView/{app_version}/Diagram/{device_id}/{device_property}/{aggregation_type}/{diagram_span} | GET | Returns diagram data in JSON(for App), CSV or HTML(with chart) format. | 926216 | ||
| AppView/AuxiliaryEquipment | No | GET | Returns documentation for the given {gateway_type}, especially information about auxiliary equipment. | 129588 | 1 |
| AppView/Translation | No | GET | Returns translations for CONNOME_Sikom_JSON_App for the given {language}. | 7098523 | |
| AppViewSimple | No | GET | Returns web app view | 177119 | |
| Authenticate | No | POST | [NO DOCUMENTATION AVAILABLE] | 0 | |
| ChangeEmail | No | GET, POST | [NO DOCUMENTATION AVAILABLE] | 1823 | |
| ChangePassword | No | GET, POST | Changes password | 10192 | 2 |
| ClearTranslationCaches | GET | [NO DOCUMENTATION AVAILABLE] | 1 | ||
| Customer | GET | Returns information about the customer or customers identified by {id} | 4656150 | 2 | |
| Customer/{customerId}/LinkEaseeAccount/{username}/{password} | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Customer/Add | No | GET, POST | Adds a new customer to the database. The parameter {email} used has to be unique. | 53190 | 1 |
| Customer/AddAsChild | GET, POST | Adds a new customer to the database and creates a parent-child relationship with the customer identified by the credentials used for authorization. | 9 | 2 | |
| Customer/AddChild | GET, POST | Adds a new parent-child relationship between two customers to the database. | 54 | ||
| Customer/AddProperty | GET, POST | Adds a user-defined property for the customers identified by {id} | 22614153 | 2 | |
| Customer/AddPropertyMultiple | GET, POST | Adds a set of user-defined properties for the customer identified by the authorization credentials used | 10001 | ||
| Customer/AddPropertyMultipleSimple | No | GET, POST | Adds a set of user-defined properties for the customer identified by the registration_id | 2751 | |
| Customer/AddPropertySimple | No | GET, POST | Adds a user-defined property for the customer identified by the registration_id | 69462 | 3 |
| Customer/ChangeGatewayOwnership/{value_code}/{new_email} | POST | [NO DOCUMENTATION AVAILABLE] | 174 | ||
| Customer/DelegateRight | GET, POST | Delegate rights from one customer to another. | 114 | ||
| Customer/FreeTextSearch/{text} | GET | [NO DOCUMENTATION AVAILABLE] | 24 | ||
| Customer/History | GET | Returns history for the customer identified by {id} | 331 | 3 | |
| Customer/Logout | GET, POST | Sets a flag resulting in the rejection of the HTTP Basic Authorization credentials next time they are supplied for authentication | 33866 | ||
| Customer/Notifications | GET | Fetch the notifications messages for the customer. If not specified the id the current user is used. | 4290976 | ||
| Customer/Property | GET | Returns property {name} for Customer identified by {id} | 4375 | 3 | |
| Customer/Receipts/{email_or_value_code}/{password} | No | GET | [NO DOCUMENTATION AVAILABLE] | 1497 | |
| Customer/ReplaceGateway | GET, POST | [NO DOCUMENTATION AVAILABLE] | 721 | ||
| Customer/Represent | GET | [NO DOCUMENTATION AVAILABLE] | 123674 | ||
| Customer/UpdateProperty | GET, POST | Updates a CustomerProperty. Only allowed to be done by admins. Only allowed for a subset of | 1233 | ||
| Device | GET | Returns information about the device or devices identified by {id} | 13996146 | 4 | |
| Device/Add | GET, POST | Manually adding of devices using ProductCode. | 675 | 1 | |
| Device/AddProperty | GET, POST | Adds a user-defined property for the devices identified by {id} | 13257979 | 2 | |
| Device/Aggregation | GET | Returns information about available aggregation history for the device identified by {id} and the property identified by {device_property}. | 3695 | 1 | |
| Device/Aggregation/History | GET | Returns aggregation history for the specified {aggregation_type} and {period} (for the device identified by {id} and the property identified by {device_property}). | 424466 | 2 | |
| Device/At | GET, POST | Stores script given by {script} for execution at time indicated by {time} | 185649 | 1 | |
| Device/History | GET | Returns history for the device identified by {id} | 770 | ||
| Device/Property | GET | Returns Property {name} for the device identified by {id}. | 78742284 | 24 | |
| Device/Refresh | GET | Updates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway) | 1230845 | 2 | |
| Device/Represent | GET | [NO DOCUMENTATION AVAILABLE] | 118 | ||
| Device/Simulate | GET, POST | Simulates reporting of value for DeviceProperty identified by {property_name} for the devices identified by {id} | 683 | 1 | |
| Device/Temperature | GET | Shorthand for calling -Device/Property- with {name} = 'temperature' and comparing against value returned. | 11 | 1 | |
| Device/TurnOff | GET, POST | Turns off the devices identified by {id} | 946090 | 1 | |
| Device/TurnOn | GET, POST | Turns on the devices identified by {id} | 1058074 | 1 | |
| Documentation/Refresh | GET | Refreshes the documentation. | 96 | ||
| ExceptionDetails | GET | Gets details for the last Exception that occurred on the server. | 588 | ||
| Gateway | GET | Returns information about the Gateway identified by {id} | 3373296 | 2 | |
| Gateway/{id}/AddGroup/{name} | GET, POST | [NO DOCUMENTATION AVAILABLE] | 2288 | ||
| Gateway/{id}/PairEaseeCharger/{chargerId}/{pinCode} | GET, POST | Pair Easee charger {chargerId} with gateway {id}. | 90 | ||
| Gateway/{id}/WeekProgram/{device_id} | GET, POST | Get the Week program with the given {id} and {device_id} | 5 | ||
| Gateway/{id}/WeekProgram/{device_id}/Delete | GET, POST | Delete the week program with the given {id} and {device_id} | 0 | ||
| Gateway/{id}/WeekProgram/{device_id}/ToggleWeekProgramActiveForNodes | GET, POST | Toggle week program active status for a list of nodeIds (representing physical devices). Note that the nodeIds sent in the method body MUST | 5 | ||
| Gateway/{id}/WeekProgram/{device_id}/Update | GET, POST | Update the Week program with the given {id} and {device_id} and request body. | 3 | ||
| Gateway/{id}/WeekProgram/Add | GET, POST | Create a new week program given for the Gateway with id {id}. | 1 | ||
| Gateway/{id}/WeekProgram/All | GET, POST | Get a list of all week programs for the gateway with the given {id} | 9 | ||
| Gateway/{valueCode}/ChangeSubscription/{newSubscriptionType} | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Gateway/{valueCode}/LinkZaptecInstallation | No | GET | [NO DOCUMENTATION AVAILABLE] | 0 | |
| Gateway/Add | No | GET, POST | Adds a Gateway to the database. | 44332 | 1 |
| Gateway/AddDealer | GET, POST | Adds a new dealer-gateway relationship to the database. | 197 | 2 | |
| Gateway/AddProperty | GET, POST | Adds or changes a user-defined property for the Gateway or Location identified by {id} | 181367 | 2 | |
| Gateway/AddPropertySimple | No | GET, POST | Adds a user-defined property for the gateway identified by the registration_id | 14453 | 2 |
| Gateway/Assign | GET, POST | Assigns the Gateway designated by registration_id (value_code) to the customer identified by customer_id. | 594 | ||
| Gateway/At | GET, POST | Stores script given by {script} for execution at time indicated by {time} | 5 | 1 | |
| Gateway/History | GET | Returns history for the gateway identified by {id} | 142 | ||
| Gateway/ListenerLog | GET | Returns BPAPIListener log information about the Gateway identified by {id} | 70971 | ||
| Gateway/Property | GET | Returns property {name} for Gateway or Location identified by {id} | 949 | 4 | |
| Gateway/Refresh | GET | Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway) | 6311700 | 3 | |
| Gateway/ReplaceWith | GET, POST | Replaces one gateway with another for a customer. | 226 | 1 | |
| Gateway/Represent | GET | [NO DOCUMENTATION AVAILABLE] | 67 | ||
| Gateway/SendRawCommand | GET, POST | Sends {command} direct to the gateway identified by {id}. | 170752 | ||
| Gateway/TransmitLocalControlKey | GET, POST | Generates a temporary key for use with subscription type LocalControl and transmits it using UDP on the provided port and IP address. The IP address has to be a local address. | 17380 | ||
| Gateway/UpdateFirmware | GET | Update the Gateway with id to the specified version. | 10 | ||
| GoogleHome | No | POST | Main method used for all calls from Google Home API. | 369686 | |
| GoogleHomeRegister/{googleClientId} | GET | Checks if the authorized customer has a google home access token, and creates one if not. | 486 | ||
| HTTPStatus | No | GET | Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message} | 553240 | |
| Message | No | POST | Dummy controller, used to get a device to log messages on. | 0 | |
| Notification/AddApp | GET, POST | Adds an identification for sending notifications to a Smartphone App | 9553072 | 3 | |
| Notification/AddCellular | GET, POST | Adds a cellular notification recipient for the customer | 13 | 2 | |
| Notification/AddEMail | GET, POST | Adds an email notification recipient for the customer | 23 | 2 | |
| Notification/AddPowel | GET, POST | Adds a Powel DMS-id for the customer | 6 | 2 | |
| Notification/SetNotificationListCellular/{values} | GET | [NO DOCUMENTATION AVAILABLE] | 24796 | ||
| Notification/SetNotificationListEmail/{values} | GET | [NO DOCUMENTATION AVAILABLE] | 24811 | ||
| Notify | GET, POST | Sends notification | 16991 | 4 | |
| Places | GET | Executes a search for places recognized by the given service (typical a weather forecast service). | 340476 | 2 | |
| Project/{project_id}/AssignToProject/{meter_ids} | GET | Used to assign gateways, in bulk identified by meter id, to a project. | 1 | ||
| Project/{project_id}/AssignToSubproject/{meter_ids} | GET | Similar to | 0 | ||
| Project/{project_id}/Diagram/{property_name}/{aggregation_type}/{diagram_span}/{period_no_or_start_date}/{end_date} | GET | [NO DOCUMENTATION AVAILABLE] | 7 | ||
| Project/{project_id}/Overview/{method_modifier} | GET | Get data related to power from the AMS devices connected to the project. | 11625 | ||
| Project/{project_id}/Subproject/{subproject_id}/Diagram/{property_name}/{aggregation_type}/{diagram_span}/{period_no_or_start_date}/{end_date} | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Project/{project_id}/Subproject/{subproject_id}/Overview/{method_modifier} | GET | Get data related to power from the AMS devices connected to the project. | 0 | ||
| Project/DisableSubproject/{subproject_id} | GET | This is a convenience method for disabling a subproject. | 0 | ||
| Project/GatewayIds | GET | Returns list of IDs for all gateway registered in a project or subproject. | 12 | 2 | |
| Property | GET | Returns information about the property identified by {id} | 52446 | 1 | |
| Property/AddProperty | GET, POST | Adds a child-property to the property identified by {id} | 6091 | 1 | |
| Property/History | GET | Shows historical values for property identified by {id} | 208797 | 6 | |
| Property/SetNoLongerCurrent | GET, POST | Marks the property identified by {id} as 'not current'. | 271800 | 1 | |
| Property/SupportIncidentsForType | GET | Shows historical values for support incidents with a specific type. For internal use only. The support | 455 | 1 | |
| RefreshTokens | No | POST | [NO DOCUMENTATION AVAILABLE] | 0 | |
| Report/001 | GET | Monthly payment report for period identified by {period} | 227566 | ||
| Report/005 | GET | [NO DOCUMENTATION AVAILABLE] | 92 | ||
| Report/006a | GET | [NO DOCUMENTATION AVAILABLE] | 68 | ||
| Report/006b | GET | [NO DOCUMENTATION AVAILABLE] | 4 | ||
| Report/006c | GET | [NO DOCUMENTATION AVAILABLE] | 14 | ||
| Report/010 | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/010b | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/010c | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/011 | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/012 | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/012b | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/012c | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Report/016 | GET | [NO DOCUMENTATION AVAILABLE] | 175 | ||
| Report/017 | GET | [NO DOCUMENTATION AVAILABLE] | 3920 | ||
| Report/018 | GET | Payment report for past 12 months | 5703 | ||
| ResetPassword | No | GET, POST | Resets password ("lost" password functionality) for customer identified by the credentials used for authorization. | 72116 | 3 |
| Subscription/CancelVipps/{gateway_id_or_transaction_id}/{is_transaction_Id} | GET | [NO DOCUMENTATION AVAILABLE] | 309 | ||
| Subscription/Receipt | No | GET | Generates and returns a PDF-receipt of the latest payment for the customer corresponding to {value_code}. | 1047 | 1 |
| Subscription/RefundVippsPayment/{transaction_id} | GET | [NO DOCUMENTATION AVAILABLE] | 8 | ||
| Subscription/Register | No | GET | This is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. | 122043 | |
| Subscription/RegisterPayment | No | GET | Registers initiation of subscription payment for the given {customer_id} and {subscription}. | 54236 | |
| Subscription/RegisterPaymentCallback | No | GET | Used by the Payment provider after the customer has completed payment for a Subscription (completion as seen from the customer's perspective) | 52081 | |
| Subscription/RegisterVippsPayment | No | GET, POST | [NO DOCUMENTATION AVAILABLE] | 8122 | |
| Subscription/RepeatPayment | GET | Executes a recurrent payment for the given {gateway_id}. | 47 | ||
| Subscription/RetryVippsPayment | GET | [NO DOCUMENTATION AVAILABLE] | 90 | ||
| Subscription/UpdateVippsAgreement/{gateway_id} | GET | [NO DOCUMENTATION AVAILABLE] | 0 | ||
| Subscription/VerifyRegistrationId | No | GET | Verifies the status of the given registration_id. | 177268 | 1 |
| Summary | GET | Returns a HTML summary for the customer identified by {id} | 137910 | ||
| Translations | No | GET, POST | Gets translations for the given {client_id} and {language}. | 1354953 | 2 |
| Translations/Version | No | GET | Gets version id of translations for the given client_id and language. | 3994203 | 2 |
| VerifyCredentials | GET | Verifies that the credentials you supply for authorization correspond to a customer in the database. | 1719114 | 1 | |
| VerifyPassword | No | GET, POST | Verifies that the {email} and {password} supplied are valid as credentials. | 234037 | 2 |
| WebShop/Order | GET | Gives details about a specific web-shop order | 0 | ||
| WebShop/RegisterPaymentCallback | No | GET | Used by the Payment provider after the customer has completed payment for a WebShop order (completion as seen from the customer's perspective) | 838 | |
| WebShop/RegisterSimple | No | GET, POST | [NO DOCUMENTATION AVAILABLE] | 3039 | |
| Sums | 289159234 | All 119 test(s) |
Automatically generated from BPAPI source-code 2025-12-06 05:04
Assembly built at 2025-09-16 10:02