The full BankID Java Server API javadoc is located in the BIDJSERVER_VX_X_X /javadoc directory on the distribution cd. The VX_X_X here symbols the current version number.

BIDFactory

registerBankIDContext

public void registerBankIDContext(
    MerchantConfig merchantConfig) throws BIDException

public void loadBankIDContext(    
	String configurationDirectoryPath,
	String merchantName,
    String passphrase) throws BIDException

public BIDFacade getFacade(
    String merchantName) throws BIDException

initTransaction

Syntax

public String initTransaction(
    String operation,
    String encKey,
    String encData,
    String encAuth,
    String sid,
    BIDSessionData sessionData) throws BIDException

Syntax

public void verifyTransactionRequest( 
	String operation, 
	String encKey, 
	String encData, 
	String encAuth, 
	String sid, 
	BIDSessionData sessionData) throws BIDException

Purpose

• This method handles the verification of data received from the client in the verifyAuth and verifySign operations, or if the client sends an handleError.
• The BIDSessionData object used in initTransaction(…) must be used as input to this method.
• The BIDSessionData object is updated and must be stored for later use.

More information about BIDSessionData can be found on the release CD under the BankID Java Server javadoc directory.

verifyTransactionResponse

Syntax

public String verifyTransactionResponse(
    BIDSessionData sessionData) throws BIDException

public InitSessionInfo initSession(
    InitSessionInfo initSessionInfo) throws BIDException

This method initiates the process of starting the BankID Web-client. The input InitSession instance must contain the following parameters:

• merchantURL (setMerchantURL)
• useragent (setUserAgent)
• action (setAction)
• localeId (setLocaleId)
• sid (setSid)
• suppressBroadcast(setSuppressBroadcast)
• showUnderstanding (setShowUnderstanding) sign only
• showConfirmation (setShowConfirmation) sign only
• docDisplayMode (setDocDisplayMode) sign only
• extPDFDomain (setExtPDFDomain) sign only, (if clientVersion 2.0)
• nextUrl (setNextUrl)
• merchantFEDomain (setMerchantFEDomain)
• certType (setCertType)
• timeout (setTimeout)
• withCredentials(setWithCredentials)
• merchantFEAncestors (setMerchantFEAncestors) (if clientVersion 2.1)
• clientSessionTimeout (setClientSessionTimeout) (if clientVersion 2.1)
• clientVersion (setClientVersion)

If another Client Proxy than the default is used, the url to the client proxy must be given. If the custom client proxy is not registered in the BankID COI database with a public key, the hex encoded modulus of the public key must be specified as well. This is done by populating the parameters in the list below:

• clientProxyURL (setClientProxyURL) (if clientVersion 2.1)
• clientProxyPublicKey (setClientProxyPublicKey) (if clientVersion 2.1)

The returned "no.bbs.server.vos.InitSessionInfo" contains the traceID received from BankID COI, and a helperURI and a clientID which are used together to retrieve the BankID Web-client. For additional information take a look at the BankID Java Server javadoc located on the BankID release CD, or see the implementation guides [IMPLW] and [IMPL].

generateMerchantReference

Syntax

public String generateMerchantReference(
    String locale) throws BIDException
  
// OR
  
@Deprecated public String generateMerchantReference() throws BIDException

requestMobileAction

Syntax

public TransactionAndStatus requestMobileAction(
    MobileInfo mobileInfo)throws BIDException

This method can be used by the merchant to perform a BankID operation using a mobile phone.
MobileInfo instance MUST contain the following parameters:

• phoneNumber
• phoneAlias
• URL
• action
• merchantReference (if action is "auth")

For more details please refer to the BankID Java Server javadoc located on the BankID release CD.

requestMobileStatus

Syntax

public String requestMobileStatus(
        String transactionReference) throws BIDException

Method to get the status from an earlier initialized mobile phone signing process. Note that this method can only be called during asynchronous communication.

pushSMS

Syntax

public String pushSMS(
    String transactionReference,
    String text) throws BIDException

This method is used for sending an SMS to the end user after a successful transaction.

getTransactionInfo

Syntax

public HashMap<String, String> getTransactionInfo(
    String key,
    List<String> oidList,
    long timeoutInMs) throws BIDException

The getTransactionInfo function can be used to request information about a transaction identified by "key". The "oidList" parameter specifies the type of information, and the "timeoutInMs" is used to kill the request if the service is slow to perform or no transaction data is available yet. 
Depending on the merchans access rights the returned HashMap will contain the requested oids and its values.

getVersionInfo

This method returns information about the BankID Java Server and the runtime environment. 

public static String getVersionInfo()

getRawTransactionInfo

public Map<String, String> getRawTransactionInfo()

getRawTransactionInfoItem

public String getRawTransactionInfoItem(
    String key)