BPAPI

BPAPI Documentation, API methods, sorted by 'Name'

NameAuthorization requiredHTTP-methods allowedHelp textPopularity (apistat)Unit tests
AppView GETReturns either AppView for
134099312
AppView/{app_version}/{gateway_id}/Refreshing GETReturns refresh status of gateway identified by {gateway_id}3306783 
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.686619 
AppView/AuxiliaryEquipmentNoGETReturns documentation for the given {gateway_type}, especially information about auxiliary equipment.
298791
AppView/TranslationNoGETReturns translations for CONNOME_Sikom_JSON_App for the given {language}.
1471610 
AppViewSimpleNoGETReturns web app view
32541 
ChangePasswordNoGET, POSTChanges password
67482
ClearTranslationCaches GET[NO DOCUMENTATION AVAILABLE]0 
Customer GETReturns information about the customer or customers identified by {id}
42286322
Customer/AddNoGET, POSTAdds a new customer to the database. The parameter {email} used has to be unique.
230421
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/AddChild GET, POSTAdds a new parent-child relationship between two customers to the database.
53 
Customer/AddProperty GET, POSTAdds a user-defined property for the customers identified by {id}
59707542
Customer/AddPropertyMultiple GET, POSTAdds a set of user-defined properties for the customer identified by the authorization credentials used
2384 
Customer/AddPropertyMultipleSimpleNoGET, POSTAdds a set of user-defined properties for the customer identified by the registration_id
856 
Customer/AddPropertySimpleNoGET, POSTAdds a user-defined property for the customer identified by the registration_id
634113
Customer/DelegateRight GET, POSTDelegate rights from one customer to another.
60 
Customer/History GETReturns history for the customer identified by {id}
2273
Customer/Logout GET, POSTSets a flag resulting in the rejection of the HTTP Basic Authorization credentials next time they are supplied for authentication 24559 
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}
600671
Device GETReturns information about the device or devices identified by {id}
130660034
Device/Add GET, POSTManually adding of devices using ProductCode.
6661
Device/AddProperty GET, POSTAdds a user-defined property for the devices identified by {id}
38198692
Device/Aggregation GETReturns information about available aggregation history for the device identified by {id} and the property identified by {device_property}.
32941
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}).4165111
Device/At GET, POSTStores script given by {script} for execution at time indicated by {time}694261
Device/History GETReturns history for the device identified by {id}
298 
Device/Property GETReturns Property {name} for the device identified by {id}.
4923251024
Device/Refresh GETUpdates the BPAPI database with current device-information from the Gateway for Device identified by {id} (fetches updated data from gateway)
4854042
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/Simulate GET, POSTSimulates reporting of value for DeviceProperty identified by {property_name} for the devices identified by {id}
6461
Device/Temperature GETShorthand for calling -Device/Property- with {name} = 'temperature' and comparing against value returned.91
Device/TurnOff GET, POSTTurns off the devices identified by {id}
8415861
Device/TurnOn GET, POSTTurns on the devices identified by {id}
9063701
Documentation/Refresh GETRefreshes the documentation.85 
ExceptionDetails GETGets details for the last Exception that occurred on the server.
490 
Gateway GETReturns information about the Gateway identified by {id}
27375522
Gateway/AddNoGET, POSTAdds a Gateway to the database.
209591
Gateway/AddDealer GET, POSTAdds a new dealer-gateway relationship to the database.
1972
Gateway/AddProperty GET, POSTAdds or changes a user-defined property for the Gateway or Location identified by {id}
648762
Gateway/AddPropertySimpleNoGET, POSTAdds a user-defined property for the gateway identified by the registration_id
120052
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. 203 
Gateway/At GET, POSTStores script given by {script} for execution at time indicated by {time}51
Gateway/History GETReturns history for the gateway identified by {id}
85 
Gateway/ListenerLog GETReturns BPAPIListener log information about the Gateway identified by {id}
42066 
Gateway/Property GETReturns property {name} for Gateway or Location identified by {id}
2024
Gateway/Refresh GETUpdates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)
56556863
Gateway/ReplaceWith GET, POSTReplaces one gateway with another for a customer.
171
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/SendRawCommand GET, POSTSends {command} direct to the gateway identified by {id}.
21024 
GoogleHomeNoPOSTMain method used for all calls from Google Home API. 18427 
GoogleHomeRegister/{googleClientId} GETChecks if the authorized customer has a google home access token, and creates one if not.173 
HTTPStatusNoGETReturns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}
276675 
Notification/AddApp GET, POSTAdds an identification for sending notifications to a Smartphone App
39795863
Notification/AddCellular GET, POSTAdds a cellular notification recipient for the customer
132
Notification/AddEMail GET, POSTAdds an email notification recipient for the customer
232
Notification/AddPowel GET, POSTAdds a Powel DMS-id for the customer
62
Notification/SetNotificationListCellular/{values} GET[NO DOCUMENTATION AVAILABLE]2330 
Notification/SetNotificationListEmail/{values} GET[NO DOCUMENTATION AVAILABLE]2335 
Notify GET, POSTSends notification
18664
Places GETExecutes a search for places recognized by the given service (typical a weather forecast service).
3324742
Property GETReturns information about the property identified by {id}301561
Property/AddProperty GET, POSTAdds a child-property to the property identified by {id}
4421
Property/History GETShows historical values for property identified by {id}
1834886
Property/SetNoLongerCurrent GET, POSTMarks the property identified by {id} as 'not current'.
1931601
RNoGETHealth test of system. Should always return bpapi_status OK151287141
Report/001 GETMonthly payment report for period identified by {period}190548 
Report/005 GET[NO DOCUMENTATION AVAILABLE]90 
Report/006a GET[NO DOCUMENTATION AVAILABLE]58 
Report/006b GET[NO DOCUMENTATION AVAILABLE]4 
Report/006c GET[NO DOCUMENTATION AVAILABLE]10 
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/016 GET[NO DOCUMENTATION AVAILABLE]171 
ResetPasswordNoGET, POSTResets password ("lost" password functionality) for customer identified by the credentials used for authorization.
440973
Subscription/ReceiptNoGETGenerates and returns a PDF-receipt of the latest payment for the customer corresponding to {value_code}.
2721
Subscription/RegisterNoGETThis is not an ordinary API-method since it returns a "complete" HTML / Javascript application for account-management. 108831 
Subscription/RegisterPaymentNoGETRegisters initiation of subscription payment for the given {customer_id} and {subscription}.
24587 
Subscription/RegisterPaymentCallbackNoGETUsed by the Payment provider after the customer has completed payment for a Subscription (completion as seen from the customer's perspective)
20851 
Subscription/RepeatPayment GETExecutes a recurrent payment for the given {gateway_id}.
46 
Subscription/VerifyRegistrationIdNoGETVerifies the status of the given registration_id.
1476881
Summary GETReturns a HTML summary for the customer identified by {id}
76518 
TranslationsNoGET, POSTGets translations for the given {client_id} and {language}.
10634602
Translations/VersionNoGETGets version id of translations for the given client_id and language.
35264922
VerifyCredentials GETVerifies that the credentials you supply for authorization correspond to a customer in the database.
4607251
VerifyPasswordNoGET, POSTVerifies that the {email} and {password} supplied are valid as credentials.
530412
WebShop/Order GETGives details about a specific web-shop order
0 
WebShop/RegisterNoPOSTPresents HTML page which handles initial registration and final checkout for a Web shop.
27 
WebShop/RegisterPayment GET, POSTRegisters initiation of WebShop payment for the given order_id.
167 
WebShop/RegisterPaymentCallbackNoGETUsed by the Payment provider after the customer has completed payment for a WebShop order (completion as seen from the customer's perspective)
215 
WebShop/RegisterSimpleNoGET, POSTA simplified version of method WebShop/Register
1314 
Sums  132585725All 117 test(s)


Automatically generated from BPAPI source-code 2020-04-07 11:17

Assembly built at 2020-04-03 13:42