API Solutions for DI

Owned by Dana Negrescu
Last updated: Dec 19, 2024
2 min read

In order for Boxalino to take onto the task of importing (automatically) information & data from 3rd party systems, the client must provide authorization acces. For most systems, this is represented by an user+password or endpoint+access token combination.

For the purpose of exporting data to Boxalino ecosystem, read access is sufficient.

Shopify

The data is accessed from a Shopify eshop by making GraphQL requests.

curl --location 'https://<shop>.myshopify.com/admin/api/<tag>/graphql.json' \ --header 'Content-Type: application/json' \ --header 'X-Shopify-Access-Token: <ACCESS TOKEN>' \ --data '{"query":"{}","variables":{}}'

An access token must be provided to ensure authorization to access resources. The access tokens are available on the basis of Shopify Apps.

Creating the Boxalino DI app

The client must create a Boxalino-DI app in Admin (Shopify Admin > Apps and sales channels > Develop Apps) https://admin.shopify.com/store/<store>/settings/apps/development

  1. Create an app in Shopify Admin

Screencast from 2024-11-08 14-33-33.webm

  1. Add Admin API Configuration (permissions to read products/orders/content/etc). NOTE: the user that created the app must have read permissions on the shared scopes as well.

Screencast from 2024-11-08 14-34-19.webm

3. After all permissions were added (a complete list is: read_customers, read_discounts, read_gift_cards, read_inventory, read_orders, read_products, read_product_feeds, read_price_rules, read_content, read_customer_events, read_locations, read_marketing_events, read_online_store_navigation, read_online_store_pages, read_product_listings, read_returns,read_locales), switch to API credentials tab and install app to generate the access token.

  1. The access token is revealed once and it must be shared with your Boxalino contact

 

PlentyMarkets

The PlentyMarkets integration is done via the PlentyMarkets API https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html

The following routes are iterated:

  1. /rest/categories

  2. /rest/category_branches

  3. /rest/items/manufacturers

  4. /rest/items/properties

  5. /rest/items/property_groups

  6. /rest/items

  7. /rest/items/variations

  8. /rest/accounts/contacts

  9. /rest/orders

In order to access the data, a user and password must be provided.

Headless CMS

The following headless CMS integrations are supported:

  1. GraphCMS / HyGraph https://hygraph.com/docs/api-reference/basics/authorization

  2. Strapi https://docs.strapi.io/user-docs/settings/API-tokens

  3. Prismic Access Token - Documentation - Prismic

  4. Directus https://docs.directus.io/reference/authentication.html

In order for our service to be able to access the data from this environment, the client must use an access token. The access token and API endpoint are specific to each system.