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}
79354 
Subscription/ReceiptNoGETGenerates and returns a PDF-receipt of the latest payment for the customer corresponding to {value_code}.
3081
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)
22339 
Subscription/RegisterPaymentNoGETRegisters initiation of subscription payment for the given {customer_id} and {subscription}.
26306 
Subscription/RegisterNoGETThis is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. 109831 
VerifyCredentials GETVerifies that the credentials you supply for authorization correspond to a customer in the database.
5160361
VerifyPasswordNoGET, POSTVerifies that the {email} and {password} supplied are valid as credentials.
611372
Subscription/VerifyRegistrationIdNoGETVerifies the status of the given registration_id.
1494221
ChangePasswordNoGET, POSTChanges password
69492
ResetPasswordNoGET, POSTResets password ("lost" password functionality) for customer identified by the credentials used for authorization.
455303
Places GETExecutes a search for places recognized by the given service (typical a weather forecast service).
3327122
Translations/VersionNoGETGets version id of translations for the given client_id and language.
35608802
TranslationsNoGET, POSTGets translations for the given {client_id} and {language}.
10843132
Documentation/Refresh GETRefreshes the documentation.85 
Gateway/AddNoGET, POSTAdds a Gateway to the database.
217431
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}
2064
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}
730302
Gateway/AssignToSubproject GETThis is a convenience method for assigning gateways to a subproject.
02
Gateway/AddPropertySimpleNoGET, POSTAdds a user-defined property for the gateway identified by the registration_id
121422
Gateway/Refresh GETUpdates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)
57064683
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}
85 
Gateway/SendRawCommand GET, POSTSends {command} direct to the gateway identified by {id}.
21189 
Gateway/ListenerLog GETReturns BPAPIListener log information about the Gateway identified by {id}
43602 
Gateway/ReplaceWith GET, POSTReplaces one gateway with another for a customer.
191
Gateway GETReturns information about the Gateway identified by {id}
27638202
Gateway/AddDealer GET, POSTAdds a new dealer-gateway relationship to the database.
1972
Customer/Logout GET, POSTSets a flag resulting in the rejection of the HTTP Basic Authorization credentials next time they are supplied for authentication 24947 
Customer/AddNoGET, POSTAdds a new customer to the database. The parameter {email} used has to be unique.
238021
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}
2853
Customer/Represent GETMarks the customer identified by the credentials used for authorization as representative of the customer identified by {id}
621181
Customer/AddProperty GET, POSTAdds a user-defined property for the customers identified by {id}
65229632
Customer/AddPropertyMultiple GET, POSTAdds a set of user-defined properties for the customer identified by the authorization credentials used
2753 
Customer/AddPropertySimpleNoGET, POSTAdds a user-defined property for the customer identified by the registration_id
637403
Customer/AddPropertyMultipleSimpleNoGET, POSTAdds a set of user-defined properties for the customer identified by the registration_id
974 
Customer/AddSubproject GETThis is a convenience method for adding a subproject.
01
Customer/DisableSubproject GETThis is a convenience method for disabling a subproject.
02
Customer/Project/GatewayIds GETReturns list of IDs for all gateway registered in a project or subproject.
02
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}
2283
Customer GETReturns information about the customer or customers identified by {id}
42592282
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
42078903
Notification/SetNotificationListCellular/{values} GET[NO DOCUMENTATION AVAILABLE]3442 
Notification/SetNotificationListEmail/{values} GET[NO DOCUMENTATION AVAILABLE]3445 
Notification/AddPowel GET, POSTAdds a Powel DMS-id for the customer
62
Notify GET, POSTSends notification
19014
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}).4203341
Device/Aggregation GETReturns information about available aggregation history for the device identified by {id} and the property identified by {device_property}.
34871
Device/At GET, POSTStores script given by {script} for execution at time indicated by {time}722181
Device/Refresh GETUpdates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)
5087112
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}.
5060585124
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}
41874062
Device/TurnOn GET, POSTTurns on the devices identified by {id}
9150501
Device/TurnOff GET, POSTTurns off the devices identified by {id}
8483061
Device/History GETReturns history for the device identified by {id}
300 
Device GETReturns information about the device or devices identified by {id}
131126864
Property/AddProperty GET, POSTAdds a child-property to the property identified by {id}
4441
Property/History GETShows historical values for property identified by {id}
1846706
Property/SetNoLongerCurrent GET, POSTMarks the property identified by {id} as 'not current'.
1960451
Property GETReturns information about the property identified by {id}308121
WebShop/RegisterPaymentCallbackNoGETUsed by the Payment provider after the customer has completed payment for a WebShop order (completion as seen from the customer's perspective)
234 
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
1404 
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}207456 
Report/005 GET[NO DOCUMENTATION AVAILABLE]91 
Report/006a GET[NO DOCUMENTATION AVAILABLE]61 
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. 24828 
GoogleHomeRegister/{googleClientId} GETChecks if the authorized customer has a google home access token, and creates one if not.194 
HTTPStatusNoGETReturns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}
289257 
ExceptionDetails GETGets details for the last Exception that occurred on the server.
498 
AppView/AuxiliaryEquipmentNoGETReturns documentation for the given {gateway_type}, especially information about auxiliary equipment.
343201
AppView/TranslationNoGETReturns translations for CONNOME_Sikom_JSON_App for the given {language}.
1723770 
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.800144 
AppView/{app_version}/{gateway_id}/Refreshing GETReturns refresh status of gateway identified by {gateway_id}3802659 
AppView GETReturns either AppView for
155602802
AppViewSimpleNoGETReturns web app view
39090 
Sums  138796898All 125 test(s)


Automatically generated from BPAPI source-code 2020-07-08 11:31

Assembly built at 2020-07-08 10:52