BPAPI

BPAPI Documentation, API methods

NameAuthorization requiredHTTP-methods allowedHelp textPopularity (apistat)Unit tests
RNoGETHealth test of system. Should always return bpapi_status OK154085941
Summary GETReturns a HTML summary for the customer identified by {id}
83212 
Subscription/ReceiptNoGETGenerates and returns a PDF-receipt of the latest payment for the customer corresponding to {value_code}.
3451
Subscription/RepeatPayment GETExecutes a recurrent payment for the given {gateway_id}.
46 
Subscription/RegisterPaymentCallbackNoGETUsed by the Payment provider after the customer has completed payment for a Subscription (completion as seen from the customer's perspective)
23634 
Subscription/RegisterPaymentNoGETRegisters initiation of subscription payment for the given {customer_id} and {subscription}.
27831 
Subscription/RegisterNoGETThis is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. 110860 
VerifyCredentials GETVerifies that the credentials you supply for authorization correspond to a customer in the database.
5667211
VerifyPasswordNoGET, POSTVerifies that the {email} and {password} supplied are valid as credentials.
686962
Subscription/VerifyRegistrationIdNoGETVerifies the status of the given registration_id.
1516201
ChangePasswordNoGET, POSTChanges password
71552
ResetPasswordNoGET, POSTResets password ("lost" password functionality) for customer identified by the credentials used for authorization.
470973
Places GETExecutes a search for places recognized by the given service (typical a weather forecast service).
3330942
Translations/VersionNoGETGets version id of translations for the given client_id and language.
35895152
TranslationsNoGET, POSTGets translations for the given {client_id} and {language}.
11019522
Documentation/Refresh GETRefreshes the documentation.92 
Gateway/AddNoGET, POSTAdds a Gateway to the database.
223441
Gateway/At GET, POSTStores script given by {script} for execution at time indicated by {time}51
Gateway/Property GETReturns property {name} for Gateway or Location identified by {id}
2274
Gateway/Represent GETMarks the customer identified by the credentials used for authorization as representative of the customer identified by {id} where {id} refers to a gateway
44 
Gateway/AddProperty GET, POSTAdds or changes a user-defined property for the Gateway or Location identified by {id}
802232
Gateway/AddPropertySimpleNoGET, POSTAdds a user-defined property for the gateway identified by the registration_id
122962
Gateway/Refresh GETUpdates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)
57477653
Gateway/Assign GET, POSTThis call is deprecated. Automatic assignment by authentication with registration_id and standard quasi-secret password as credentials may be used instead. 206 
Gateway/History GETReturns history for the gateway identified by {id}
87 
Gateway/SendRawCommand GET, POSTSends {command} direct to the gateway identified by {id}.
21920 
Gateway/ListenerLog GETReturns BPAPIListener log information about the Gateway identified by {id}
46972 
Gateway/ReplaceWith GET, POSTReplaces one gateway with another for a customer.
271
Gateway GETReturns information about the Gateway identified by {id}
27864732
Gateway/AddDealer GET, POSTAdds a new dealer-gateway relationship to the database.
1972
Gateway/TransmitLocalControlKey GET, POSTGenerates 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.0 
Customer/Logout GET, POSTSets a flag resulting in the rejection of the HTTP Basic Authorization credentials next time they are supplied for authentication 25491 
Customer/AddNoGET, POSTAdds a new customer to the database. The parameter {email} used has to be unique.
246621
Customer/AddAsChild GET, POSTAdds a new customer to the database and creates a parent-child relationship with the customer identified by the credentials used for authorization.
92
Customer/Property GETReturns property {name} for Customer identified by {id}
2873
Customer/Represent GETMarks the customer identified by the credentials used for authorization as representative of the customer identified by {id}
649981
Customer/AddProperty GET, POSTAdds a user-defined property for the customers identified by {id}
70244542
Customer/AddPropertyMultiple GET, POSTAdds a set of user-defined properties for the customer identified by the authorization credentials used
3139 
Customer/AddPropertySimpleNoGET, POSTAdds a user-defined property for the customer identified by the registration_id
641493
Customer/AddPropertyMultipleSimpleNoGET, POSTAdds a set of user-defined properties for the customer identified by the registration_id
1093 
Customer/Notifications GETFetch the notifications messages for the customer. If not specified the id the current user is used.796 
Customer/AddChild GET, POSTAdds a new parent-child relationship between two customers to the database.
53 
Customer/DelegateRight GET, POSTDelegate rights from one customer to another.
60 
Customer/History GETReturns history for the customer identified by {id}
2353
Customer GETReturns information about the customer or customers identified by {id}
42868022
Notification/AddEMail GET, POSTAdds an email notification recipient for the customer
232
Notification/AddCellular GET, POSTAdds a cellular notification recipient for the customer
132
Notification/AddApp GET, POSTAdds an identification for sending notifications to a Smartphone App
44199523
Notification/SetNotificationListCellular/{values} GET[NO DOCUMENTATION AVAILABLE]4631 
Notification/SetNotificationListEmail/{values} GET[NO DOCUMENTATION AVAILABLE]4635 
Notification/AddPowel GET, POSTAdds a Powel DMS-id for the customer
62
Notify GET, POSTSends notification
20264
Device/Add GET, POSTManually adding of devices using ProductCode.
6681
Device/Aggregation/History GETReturns aggregation history for the specified {aggregation_type} and {period} (for the device identified by {id} and the property identified by {device_property}).4230412
Device/Aggregation GETReturns information about available aggregation history for the device identified by {id} and the property identified by {device_property}.
36531
Device/At GET, POSTStores script given by {script} for execution at time indicated by {time}757371
Device/Refresh GETUpdates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)
5292852
Device/Temperature GETShorthand for calling -Device/Property- with {name} = 'temperature' and comparing against value returned.91
Device/Simulate GET, POSTSimulates reporting of value for DeviceProperty identified by {property_name} for the devices identified by {id}
6481
Device/Property GETReturns Property {name} for the device identified by {id}.
5193813624
Device/Represent GETMarks the customer identified by the credentials used for authorization as representative of the customer identified by {id} where {id} refers to a device
107 
Device/AddProperty GET, POSTAdds a user-defined property for the devices identified by {id}
45744802
Device/TurnOn GET, POSTTurns on the devices identified by {id}
9235991
Device/TurnOff GET, POSTTurns off the devices identified by {id}
8551841
Device/History GETReturns history for the device identified by {id}
314 
Device GETReturns information about the device or devices identified by {id}
131522874
Property/AddProperty GET, POSTAdds a child-property to the property identified by {id}
4481
Property/History GETShows historical values for property identified by {id}
1859816
Property/SetNoLongerCurrent GET, POSTMarks the property identified by {id} as 'not current'.
1990631
Property GETReturns information about the property identified by {id}317151
WebShop/RegisterPaymentCallbackNoGETUsed by the Payment provider after the customer has completed payment for a WebShop order (completion as seen from the customer's perspective)
263 
WebShop/RegisterNoPOSTPresents HTML page which handles initial registration and final checkout for a Web shop.
27 
WebShop/RegisterSimpleNoGET, POSTA simplified version of method WebShop/Register
1554 
WebShop/Order GETGives details about a specific web-shop order
0 
WebShop/RegisterPayment GET, POSTRegisters initiation of WebShop payment for the given order_id.
167 
Report/001 GETMonthly payment report for period identified by {period}223181 
Report/005 GET[NO DOCUMENTATION AVAILABLE]91 
Report/006a GET[NO DOCUMENTATION AVAILABLE]62 
Report/006b GET[NO DOCUMENTATION AVAILABLE]4 
Report/006c GET[NO DOCUMENTATION AVAILABLE]13 
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]171 
Nordpool/FetchPrices GETFetch prices of the energy for the next day from Nordpool group01
ClearTranslationCaches GET[NO DOCUMENTATION AVAILABLE]0 
GoogleHomeNoPOSTMain method used for all calls from Google Home API. 31787 
GoogleHomeRegister/{googleClientId} GETChecks if the authorized customer has a google home access token, and creates one if not.205 
HTTPStatusNoGETReturns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}
304651 
ExceptionDetails GETGets details for the last Exception that occurred on the server.
510 
AppView/AuxiliaryEquipmentNoGETReturns documentation for the given {gateway_type}, especially information about auxiliary equipment.
388971
AppView/TranslationNoGETReturns translations for CONNOME_Sikom_JSON_App for the given {language}.
1967636 
AppView/{app_version}/Diagram/{device_id}/{device_property}/{aggregation_type}/{diagram_span} GETReturns diagram data in JSON(for App), CSV or HTML(with chart) format.889223 
AppView/{app_version}/{gateway_id}/Refreshing GETReturns refresh status of gateway identified by {gateway_id}4254978 
AppView GETReturns either AppView for
176448172
AppViewSimpleNoGETReturns web app view
44807 
Project/{project_id}/AssignToProject/{meter_ids} GETUsed to assign gateways, in bulk identified by meter id, to a project.1 
Project/DisableSubproject/{subproject_id} GETThis is a convenience method for disabling a subproject.
0 
Project/GatewayIds GETReturns list of IDs for all gateway registered in a project or subproject.
12
Project/{project_id}/Overview/{method_modifier} GET /// Get data related to power from the AMS devices connected to the project.100 
Project/{project_id}/Subproject/{subproject_id}/Overview/{method_modifier} GETGet data related to power from the AMS devices connected to the project.0 
Project/{project_id}/AssignToSubproject/{meter_ids} GETSimilar to but on subproject basis.0 
Project/{project_id}/Diagram/{property_name}/{aggregation_type}/{diagram_span}/{period_no_or_start_date}/{end_date} GET[NO DOCUMENTATION AVAILABLE]3 
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 
MessageNoPOSTDummy controller, used to get a device to log messages on.0 
Sums  144464268All 121 test(s)


Automatically generated from BPAPI source-code 2020-09-30 08:40

Assembly built at 2020-09-25 13:07