BPAPI Methods

BPAPI method VerifyCredentials

VerifyCredentials

Verifies that the credentials you supply for authorization correspond to a customer in the database.

Authorization required: Yes

HTTP methods allowed: GET

Syntax: VerifyCredentials  Details 

Verifies that the credentials you supply for authorization correspond to a customer in the database.
Note that the credentials in themselves are not supplied as parameters to this method as authorization is done "outside" of BPAPI (as HTTP Basic authentication)

Returnes scalar_result true if the credentials are correct

If the credentials are not correct the response will be an error message from the authorization mechanism used,
this will not be in the standard BPAPI-format, that is bpapi_status, scalar_result or similar will NOT be defined.

This method is somewhat more reliable than just doing an API-call and checking that no HTTP 4xx error code was returned, since
it checks for the affirmative instead of the negative. It is recommended that the client uses this method whenever the client asks the
user for credentials (that is, whenever the client asks the user for login-information).


See also VerifyPassword which may be better for Javascript-applications running in a web-browser


Unit-tests: 1 test(s)

Popularity: 458779 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-04-05 01:17