Authentication

generating api keys fill out the "request api documentation" form linked on boom's rent reporting as a service page https //www boompay app/rent reporting as a service your request will be reviewed, and you will be emailed and invited to a sandbox https //portal sandbox boompay app/ and production https //portal boompay app/ boom partner platform in the boom partner platform, navigate to the "settings" page from the menu on the bottom left and proceed to the settings > api in the api tab, you will be presented with an access key and secret key , which you will need to generate the model prompt will show you your secret key, which will only be shown to you once make sure to save this in a secure place make sure you have access to sandbox and production, and generate keys in both places for your local and production environments respectively api authentication every api request to boom servers must include an authentication api token token is a jwt token generated with the hs256 algorithm if you are not familiar with jwt we highly recommend reading more about it here https //jwt io/introduction/ get api token in order to get an api token you must use the access key and secret key from the portal curl location request post 'https //api sandbox boompay app/partner/v1/authenticate' \\ \ header 'content type application/json' \\ \ data raw '{ "access key" "sample access key", "secret key" "sample secret key" }' making requests to boom api there 2 ways of setting up authentication simplest way is to just pass the api token with a bearer header curl location request post 'https //api sandbox boompay app/v1/partners/customers' \\ \ header 'authorization bearer \<api token>' \\ \ header 'content type application/json' \\ \ data raw '{ "first name" "john", "last name" "doe", "email" "uniquejohndoe\@boompay app", "phone" "12345678910" }' if enhanced security configuration is enabled, jwt verification secret will be surfaced in the "developers" https //portal boompay app/settings/developers page and you will have to pass an additional header x access token with an access key value in addition to api token in order to enable enhanced security verification please contact boom curl location request post 'https //api sandbox boompay app/v1/partners/customers' \ header 'authorization bearer \<api token>' \ header 'x access token \<access key>' \ header 'content type application/json' \ data raw '{ "first name" "john", "last name" "doe", "email" "uniquejohndoe\@boompay app", "phone" "12345678910" }'