DOCUMENTATION.md

Documentation

You can see below the API reference of this module.

brokerbin(auth)

BrokerBin API wrapper for Node.js

Params

• Object auth: An object containing the following data:
  • username (String): The BrokerBin username (or ENV variable: BROKERBIN_USERNAME)
  • password (String): The BrokerBin password (or ENV variable: BROKERBIN_PASSWORD)
  • soap_key (String): The BrokerBin soap key (or ENV variable: BROKERBIN_SOAP_KEY)
  • soap_uri (String): The BrokerBin soap uri (or ENV variable: BROKERBIN_SOAP_URI)
  • public_key (String): The BrokerBin public key (or ENV variable: BROKERBIN_PUBLIC_KEY)

Return

• Number Return description.

authenticate

Setup the API authentication.

Return

• Promise Resolves with the UID.

search

Runs a search request in BrokerBin.

Return

• Promise Resolves with the results.