The Lyftron Provider for Aftership offers the most natural way to access Aftership data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Aftership data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Aftership data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
- Comprehensive Delta load mechanism.
- Real-time access to Aftership.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
The user must have credentials for Aftership, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Step1: Setup aftership account
1.1 Create account in AfterShip and login
1.2. After Login go to -> Setting and click on -> Api key
1.3 Click on -> Generate API Key to create your own API keys
Establishing a Connection with Lyftron's Quickstart Steps
Create your Aftership connection with Lyftron by following these easy steps show below:
Step2 : Login to Lyftron
Start creating your connection
2.1 Create Connection click on connect -> Add connection On the left side of the panel, Choose your provider -> Type AfterShip in search bar and click Aftership for your connection
2.3 Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Aftership connection with Lyftron.
Give connection name as AfterShip -> Replace “your_api_key” with AfterShipApi-key , click on test connection -> click save.Profile=C:\profiles\Aftership.apip;ProfileSettings='APIKey=< your_api_key >'
|Connection Name||Enter your connection details||Required|
|APIKey||your Aftership APIKey||Required|
|Logfile**||Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx||Optional|
|Verbosity**||Choose verbosity 1-5 based on the severity of debugging||Optional|
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Save your connection
Step3 : Normalize
Create data source
After establishing connection, datasource metadata import is needed and for that Lyftron automatically normalize your API & different SQL dialects data into ANSI SQL format and also gives you API sources into simple, code less out of the box data model.
3.1 Click on Normalize section from the left panel -> Click on Add Data Source button ,Enter data source name -> Choose AfterShip from the existing list -> Click next
3.3 Choose the table you want to import and -> Click Create
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
|AllCouriers||Tables||Return a list of all couriers.|
|LastCheckpoint||Tables||Get tracking information of the last checkpoint of a tracking.|
|MyCouriers||Tables||Return a list of couriers activated at your AfterShip account.|
|Notifications||Tables||Get contacts (sms or email) to be notified when the status of a tracking has changed.|
|Trackings||Tables||Get the tracking details of the shipment.|
Step 4: Analyze
Querying the data source data
Lyftron allows you to query the source data by simply writing the ANSI Sql query. Please keep in mind as the data is coming directly from API so, there’s a limit to API calls and performance delay from the Stripe API side which Lyftron can’t control so, don’t expect to pull millions of records in just fraction of seconds. If you have heavy data loads, create the pipeline to unload that data into the Lyftron warehouse and query from it.
4.1. Click on the analyze section on the left panel -> Choose data source from the list Drag and drop the table -> Choose your querying options
4.3. Click on -> EXECUTE and selected query will return data successfully
To view a detailed advanced settings options, go to Aftership Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.