dbursic

API Key Generate for Onprem eSign

0 votes
Looking for some guidance on how to obtain an API key for the onprem version of onespan. My question is, how do we generate and use the api key? In our lower environment we have a key that our app uses that is not referenced in the UI and it decodes into 2 keys xxx:xxx where the ui keys generated on the user page decode into username:xxx. We can’t seem to figure out how to create this other key. Any point in the right direction would be awesome. Thanks. checked on backoffice for the ui keys which i found on the user profiles checked on frontend for any keys, unable to locate

Reply to: API Key Generate for Onprem eSign

1 votes
Hi there, Once an account was created or when a sender was added to an account, an API Key should automatically be generated and specified to the person. (so you can't generate it manually) As you observed, the API Key was encoded based on xxx:xxx, which the first part refers to the sender ID and the second key might be a salt value stored in the database. However, it's not the recommended way to get the API Key. Below was the steps to do so: First you'd check whether the email was an account owner or a normal member. For account owner: (1)In backoffice (https://{your_on_prem_domain}/backoffice), make sure the account has enabled the "Allow Integration" feature. (API Key was only exposed to integrated users) (2)Login through Sender UI (https://{your_on_prem_domain}/login), click the head icon besides your name, on top right, and select the "Admin" option. Choose the "Integration" section from the page and you will find the API Key get masked. For other members under an account: You need to use account owner's API Key and send an API to retrieve the sender's API Key: GET /api/account/senders/{senderId}/apiKey You can either write some script or through postman, or follow below steps: (1)Get the sender ID from backoffice "Sender Details" page (2)Login Sender UI as the account owner (in order to get a browser cookie) (2)hit https://{your_on_prem_domain}/api/account/senders/{senderId}/apiKey Hope this could help! Duo

Duo Liang OneSpan Evangelism and Partner Integrations Developer


Reply to: API Key Generate for Onprem eSign

0 votes
thanks, this was helpful in getting me where i needed to go.

Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off