Data Feeds (DF)
- Dana Negrescu
In order to assist with the Data Integration (DI) efforts with 3rd party systems (ex: Productsup, Google Shopping, Google Sheet, Google Ads, etc), Boxalino is presenting the Data Feeds services.
Use this service to:
Export your data to other tools in your project (ex: productsup, google shopping feed, etc)
Accessing calculated data in a structured way (per request)
Load files directly to your GCP ecosystem (for order, customers enrichment)
This is service is currently expanding. We value our clients' feedback.
For further service requests and data feeds, please get in touch with Boxalino.
GETTING STARTED
For any data required to be exposed (privately), follow the bellow steps:
Get in touch with Boxalino to receive an access key
Communicate the purpose of the data feed & desired information
We will provide an access key
Share the access key with the integration team
The integration team makes an HTTP request to access the data (per documentation bellow)
READ FEED REQUEST
There should be a process within the client project that reads the data from the /read/{access-key} service.
The {access-key} is provided by Boxalino.
As an integrator, please create the bellow request to the provided endpoint.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app | |
|---|---|---|---|
| 2 | Action | /read/{access-key} | |
| 3 | Method | POST | |
| 4 | Headers | Authorization | Basic base64<<READ API key : READ API Secret>> note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned  *Read more about credentials https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/713785345 |
The data exposed in the data feed is in a JSON format.
VIEW FEED REQUEST
As an integrator, please create the bellow request to the provided endpoint.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app | |
|---|---|---|---|
| 2 | Action | /view/{access-key} | |
| 3 | Method | POST | GET | |
| 4 | Parameters (optional) | separator | Default: comma (,) |
| 5 | format | Default: csv | |
| 6 | page | (optional) pagination; by default - all results are returned; | |
| 7 | limit | (optional) set a limit for number of rows per request by default - no limit; when used with page - default limit is 1000. | |
| 8 | Authorization | only if the key is for authenticated requests note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned *Read more about credentials https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/713785345 | |
*Currently, the data exposed in the data feed is in a CSV format.
VIEW GOOGLEADSFEED REQUEST
As an integrator, please create the bellow request to the provided endpoint.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app | |
|---|---|---|---|
| 2 | Action | /view/googleadsfeed/{access-key}?name=<feed-name> | |
| 3 | Method | POST | GET | |
| 4 | Parameters (optional) | separator | Default: comma (,) Define a different separator for the .csv file ( tab, pipe (|), etc). One character only! NOTE: the default will be upgraded to “tab” in order to allow a list of data for value (ex: multivalue fields) |
| 5 | format | Default: csv Change the format of export (ex: txt) | |
*Currently, the data exposed in the data feed is in a CSV format.
JSON FEED REQUEST
As an integrator, please create the bellow request to the provided endpoint.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app |
|---|---|---|
| 2 | Action | /json/{access-key}?name=<feed-name> |
| 3 | Method | POST | GET |
| 4 | Authorization (header) | only if the key is for authenticated requests note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned *Read more about credentials https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/713785345 |
| 5 | Parameters (optional) | |
| 6 | page | (optional) pagination; by default - all results are returned; |
| 7 | limit | (optional) set a limit for number of rows per request by default - no limit; when used with page - default limit is 1000. |
The data exposed in the data feed is in a JSON format.
GOOGLE SHOPPING FEED REQUEST
As an integrator, please create the bellow request to the provided endpoint.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app |
|---|---|---|
| 2 | Action | /googleshoppingfeed/{access-key} |
| 3 | Method | POST | GET |
| 4 | Authorization (header) | only if the key is for authenticated requests note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned *Read more about credentials https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/713785345 |
| 5 | Parameters (optional) | |
| 6 | page | (optional) pagination; by default - all results are returned; |
| 7 | limit | (optional) set a limit for number of rows per request by default - no limit; when used with page - default limit is 1000. |
LOAD FEED REQUEST
The LOADFEED service was created in order to load files directly into your project`s BigQuery ecosystem from Boxalino.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app |
|---|---|---|
| 2 | Action | /loadfeed/{access-key}?name=<feed-name> |
| 3 | Method | POST | GET |
Adding a new loadfeed configuration model
The loadfeed configuration model is defined in the input_data_feeds view in the client`s account dataset.
SELECT
'<FEED NAME>' as name
, '<FEED SOURCE: direct|aws>' AS source
, '<ACCESS CONFIGURATION/HEADERS AS JSON>' AS access
, '<LINK OR PATH TO FILES TO BE DOWNLOADED>' AS url
, '' AS body
, ';' AS field_delimiter
, '<CONTENT FORMAT: CSV,NEWLINE_DELIMITED_JSON>' AS format
, '<BOXALINO ACCOUNT NAME>_core' AS destination_dataset
, '<TABLE NAME>' AS destination_table
, true AS autodetect
, '<SCHEMA (string or JSON) IF autodetect=false>' AS schema
, 0 AS add_body_as_record
, 0 AS add_tm_to_record
, 1 AS skipRows
, 0 AS max_bad_records
, '' AS quote
, 'WRITE_TRUNCATE | WRITE_APPEND' AS write_disposition
, '' AS create_disposition
, '' AS encoding
, '<CRONJOB CONFIGURATION FOR LOADING FILES, EX: 20 12 * * *>' AS cronjob
, 'feed' AS typeGOOGLE SHEET FEED REQUEST
The GOOGLESHEETFEED service was created in order to import google sheets directly into your project`s BigQuery ecosystem from Boxalino.
| 1 | Endpoint | https://boxalino-winning-interactions-krceabfwya-ew.a.run.app |
|---|---|---|
| 2 | Action | /googlesheetfeed/{access-key}?name=<feed-name> |
| 3 | Method | POST | GET |
Adding a new googlesheetfeed configuration model
The googlesheetfeed configuration model is defined in the google_sheet_data_feeds view in the client`s account dataset.
SELECT
'<FEED NAME>' as name
, '<ID of the google sheet>' AS id
, '<A1:D50>' AS sheet_range
, ';' AS field_delimiter
, 'CSV' AS format
, '<BOXALINO ACCOUNT NAME>_core' AS destination_dataset
, '<TABLE NAME>' AS destination_table
, true AS autodetect
, '<SCHEMA (string or JSON) IF autodetect=false>' AS schema
, 1 AS skipRows
, 0 AS max_bad_records
, '' AS quote
, 'WRITE_TRUNCATE | WRITE_APPEND' AS write_disposition
, '' AS create_disposition
, '' AS encoding
, '<CRONJOB CONFIGURATION FOR LOADING FILES, EX: 20 12 * * *>' AS cronjob
, 'googlesheet' AS type