Versions Compared

Version Old Version 11 New Version Current
Changes made by

Dana Negrescu

Dana Negrescu

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The credentials are available in Boxalino Intelligence Admin, in the Account view https://intelligence-demo.bx-cloud.com/#/app/account

Note

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

...

Based on your API request context, there are different set of API credentials for:

  1. accessing the dev data index

    Image Modified

  2. accessing the live data index

    Image Modified

Roles

Based on the context of the API request, the API credentials used must have one of the designated roles:

  1. CORE - use this role for API requests server-side (ex: search, navigation, batch etc)

  2. PUBLIC_NARRATIVE - used for client-side requests (ex: JS quicksearch), it only requires the API key and no API secret

  3. 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

  4. PUBLIC_REST - used as values for the Newsletter REST integration Newsletter Image & Redirect URLs . It only has an API key and NO API SECRET.

  5. PUBLIC_READ - used as BASIC AUTHORIZATION HEADERS for your Data Feed (DF) requestsData Feeds (DF)

Generation of the credentials

If you need more API credentials, it is possible to generate them directly from Intelligence Admin.

Steps #5 and #6 can be done once every pair of API key was created.

  1. Log in Intelligence Admin https://intelligence.bx-cloud.com/#/page/login

  2. Access the Account view https://intelligence.bx-cloud.com/#/app/account

  3. Click on “+Add API key” to add a new record

    Image Modified

4. On the appeared row, do the following:

...