As a practice, the API credentials are generated by the integration team/client with every feature release.
Optionally, we can also provide them in a kick-off email (per request).
The credentials are available in Boxalino Intelligence Admin, in the Account view https://intelligence.bx-cloud.com/#/app/account
Make sure to use the appropriate API credentials for the scope of your request:
1. Data integration access
2. API request role
3. Data feed access
4. Newsletter access
Access
Based on your API request context, there are different set of API credentials for:
accessing the dev data index
accessing the live data index
Roles
Based on the context of the API request, the API credentials used must have one of the designated roles:
CORE - use this role for API requests server-side (ex: search, navigation, batch etc)
PUBLIC_NARRATIVE - used for client-side requests (ex: JS quicksearch), it only requires the API key and no API secret
ADMIN - used as values for the BASIC AUTHORIZATION HEADERS for your Data Integration (DI) requests https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/394559761/Sync+Request#Request-Definition / or Boxalino Convert endpoint test&review Boxalino Convert Endpoint
PUBLIC_REST - used as values for the Newsletter REST integration Newsletter Image & Redirect URLs . It only has an API key and NO API SECRET.
PUBLIC_READ - used as BASIC AUTHORIZATION HEADERS for your Data Feed (DF) requestsData Feeds (DF)
Generation of the credentials
Steps #5 and #6 can be done once every pair of API key was created.
Log in Intelligence Admin https://intelligence.bx-cloud.com/#/page/login
Access the Account view https://intelligence.bx-cloud.com/#/app/account
Click on “+Add API key” to add a new record
4. On the appeared row, do the following:
a) Set the STATUS to “Active”
b) Click on “GENERATE” to create each API Key / Secret
c) Select the required ROLE https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/713785345/API+Credentials#Roles
d) Select the environments (all for ADMIN key)
5. Click on “
Save Account”
6. Click on “
Generate API Keys”
0 Comments