Skip to main content

​
Introduction

Batch file import into BSPK are performed via AWS S3 buckets. Your company has its own dedicated S3 bucket provisioned by BSPK. S3 access keys (S3 keys) give you the ability to programmatically upload files to your company S3 bucket and automate any part of your workflow with the BSPK import. You can get more details on the import process in Core Data Integration Guide

​
Managing S3 keys

To be able to work with S3 buckets directly, you need to create an S3 key. To do this, please go to the corresponding section in your company’s Admin portal. Select the S3 Keys link in the Manage section. S3 Keys A list of all your S3 keys will be displayed. Take a note your company S3 bucket name. You will need it later.
Please note that you can only have up to two active S3 keys at a time.
S3 Keys

​
Creating S3 key

To start the flow to create an S3 key, click the Create S3 Key button. In the new page, confirm your action by clicking Create S3 Key. Create S3 Key Sometimes (especially when you create your S3 key for the first time) AWS will take some time to setup your access. Please be patient and do not close or refresh the page you’re currently on. Successful S3 key creation Once your S3 key was created, you MUST write down your secret key and store it in a safe place. BSPK does not store keys. Once a key has been generated, we can’t recover the secret. If you lose the secret key, the only option is to delete the old S3 key and create a new one.

​
Deleting S3 key

From time to time, you may want to rotate your keys and delete your old S3 key.
AWS Security Best Practices recommend rotating (deleting the old S3 key and creating a new one) periodically, at least twice a year.
To do this, click the Delete button corresponding to the existing S3 key. Delete S3 Key After confirmation, the S3 key will be deleted.

​
AWS Errors

Sometimes there can be transition error communicating with AWS. If you see an error, "Something went wrong. Please try again later", do not worry. Wait for a minute and try again. AWS Error If the error persists, please contact your local support.

​
Managing S3 keys video

​
Working with S3 Buckets

Once you have created your S3 keys, you are ready to upload files to your S3 bucket. There are many options available.

​
Programatic Integration

AWS has a very detailed guide on how you can upload files using S3 Keys. Uploading objects - Amazon Simple Storage Service These can be done with:
  • AWS SDK integration
    • .NET
    • Java
    • Javascript
    • Ruby
    • PHP
  • REST API (Ex. Postman and many GUI clients for differents OSes)
  • AWS CLI
To minimize security risks and follow best practices, S3 key are limited to file upload and listing in your company’s S3 bucket. You can’t download or delete files.
Please use your company S3 bucket name in the examples below

​
AWS CLI

First install the AWS CLI. Please follow the instructions in the official AWS guide. Once the AWS CLI is installed, please run the aws configure command. Provide Access Key ID and Secret Access Key to the console input. Region name and output format should be entered as displayed below. Please be mindful of trailing and leading spaces - they should not be present. AWS CLI Configure Once AWS CLI is configured, you can use it to upload and list with following commands. Listing your bucket files 
aws s3 ls s3://bspk-test-company-integration-dev2
Uploading your files to S3 bucket 
aws s3 cp test-file.csv s3://bspk-test-company-integration-dev2

​
CyberDuck client

Cyberduck is a free cloud storage browser under the GPL license available on Mac OS and Windows. To setup a new connection, choose Amazon S3 connection profile and fill out fields as in the example below. CyberDuck S3 Connection It is essential to provide Path in More Options section. Once filled, you can connect to your S3 bucket. From there you can list and upload files. CyberDuck Upload Successful upload message. CyberDuck Upload success

​
S3 Browser

S3 Browser is a freeware Windows client for Amazon S3 and Amazon CloudFront. Please note that free version is available only for personal use. To setup your account, please fill in fields as described below. S3 Browser Setup Also, setup Advanced settings as described below. S3 Browser Advanced settings Once account setup is finished you will see the main window where you can list and upload files. S3 Browser Main window

​
Postman client

For Postman client, please use this collection of two requests (upload file and list files). Before use, please fill in collection variables - s3_bucket_name, access_key_id and secret_key_value with corresponding values. bspk_s3_keys_requests.postman_collection.json

​
File Import Logs

To verify that import files were processed correctly, you can visit Import Logs menu item in Activity section. Import Logs There you can review all import results that you have uploaded. Import Logs Index If there are errors during import process you can review them in import details by clicking on Show button. Import Logs Details