Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
okra-js
Advanced tools
Readme
JS library for implementing the OkraJS widget - OkraJS is a safe and secure web drop-in module and this library provides a front-end web (also available in iOS and Android) SDK for account authentication and payment initiation for each bank that Okra supports.
Checkout the widget flow to view how the Okra Widget works. Click "See How it Works"
buildWithShortURL
version, you will first need to create a link on your dashboard, and use the short url
returend at the end of the creation flow.Bonus Points
Using npm:
$ npm install okra-js
Using yarn:
$ yarn add okra-js
Using CDN:
<script src="https://cdn.okra.ng/v2/bundle.js"></script>
For JS frameworks import it and use
import Okra from 'okra-js'
For others, just use
Okra.buildWithOptions({
name: 'Peter the Builder',
env: 'production-sandbox',
app_id: '',// app_id from your App builder
key: '', // Your key from the Okra dashboard
token: '', // Your token from the okra dashboard
products: ['auth','identity','balance','transactions', 'income'], //in lowercase
onSuccess: function(data){
console.log('options success', data)
},
onClose: function(){
console.log('options close')
}
})
// OR
Okra.buildWithShortUrl({
short_url: '', //Your short url from the App builder (https://dash.okra.ng/links)
onSuccess: function(data){
console.log('options success', data)
},
onClose: function(){
console.log('options close')
}
})
Name | Type | Required | Default Value | Description |
---|---|---|---|---|
app_id | String | true | Your app id from your Okra Dashboard. | |
okraKey | String | true | Your public key from your Okra Dashboard. | |
token | String | true | Your token from your Okra Dashboard. | |
env | String | false | production | production(live)/production-sandbox (test) |
products | Array | true | ['Auth'] | The Okra products you want to use with the widget. |
payment | Booelan | false | Whether you want to initiate a payment (https://docs.okra.ng/docs/payments) | |
charge | Object | false | Payment charge opject (https://docs.okra.ng/docs/widget-properties#set-up-payments) | |
products | Array | true | ['Auth'] | The Okra products you want to use with the widget. |
logo | String(URL) | false | Okra's Logo | |
name | String | false | Your Company's name | Name on the widget |
color | HEX | false | #3AB795 | Theme on the widget |
limit | Number | false | 24 | Statement length |
filter | Object | false | Filter for widget | |
isCorporate | Boolen | false | false | Corporate or Individual account |
connectMessage | String | false | Instruction to connnect account | |
widget_success | String | false | Widget Success Message | |
widget_failed | String | false | Widget Failed Message | |
callback_url | String(Url) | false | ||
currency | String | false | NGN | Wallet to bill |
exp | Date | false | Won't expire | Expirary date of widget |
options | Object | false | You can pass a object custom values eg id | |
onSuccess | Function | false | Action to perform after widget is successful | |
onClose | Function | false | Action to perform if widget is closed | |
onError | Function | false | Action to perform on widget Error | |
BeforeClose | Function | false | Action to perform before widget close | |
onEvent | Function | false | Action to perform on widget event |
View a complete list of customizable options here
Name | Type | Required | Description |
---|---|---|---|
short_url | String | true | Your generated url from our App builder. |
onSuccess | Function | false | Action to perform after widget is successful |
onClose | Function | false | Action to perform if widget is closed |
onError | Function | false | Action to perform on widget Error |
BeforeClose | Function | false | Action to perform before widget close |
onEvent | Function | false |
Checkout our API Overiview and see how to use the data you've received and other products you can use to create more personalized experiences for your customers!
Get started without writing a single line of code, Try our App Builder! Click here to get started
For enquires and questions, contact
FAQs
JS library for implementing Okra widget
The npm package okra-js receives a total of 197 weekly downloads. As such, okra-js popularity was classified as not popular.
We found that okra-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.