Folder polling integration and set up
Folder Polling and Pushing is an alternative to FTP based file transfer which is intended for use in circumstances where the customer's systems do not offer even an FTP based file transfer mechanism.
The Folder Polling and Pushing is facilitated by the use of the ‘MachShip App’, which is the same program that MachShip produces to allow for automatic printing of documentation and labels at customer sites.
‘Folder Polling’ refers to a practice whereby the installed MachShip App will ‘watch’ a folder on a client’s server or computer for files and wait for those files to appear. When the files eventually appear, the MachShip App will pick them up and transfer them to MachShip using the RESTful API so that the appearance and functionality of an FTP transfer method are realised and achieved.
An example workflow:
- MachShip App is configured to watch a particular folder.
- Consignment created in the customer's system.
- Customer's system creates the required file and saves the file in the specified folder.
- MachShip App uploads the file to MachShip.
- Consignment is created in MachShip.
- If there are any issues with the file, these issues will need to be resolved manually outside of this workflow. These will be advised via email.
Technical Level: IT Administrator
Setup
- Customer's system
- Setup structured files to be generated from the customer's systems
- Setup - MachShip system
- Install the app on-site at the customer's premises
- Configure the app through MachShip
- Setup - MachShip team
Additional Setup for client-specific file:
- MachShip team
- Develop the mapping to read and import the customer's specific file format
Functionality
- Creating Consignments or Pending Consignments
Related Articles
Customer integration overview and questionnaire
MachShip – Customer-Side Integrations We offer several methods of integration so that a customer's system can integrate directly with MachShip so as to avoid manual intervention or duplicate data entry. These systems differ in complexity and ...
RESTful API Integration and Set up
RESTful API The restful API is a layer of a programming architecture that exposes a fixed, documented set of GET and POST methods that can be used to integrate advanced backend customer systems with MachShip. This layer of integration is the most ...
Machship API Integration Workflow Guide
The objective of this article is to give you a quick-start guide in working with our API to achieve common integration workflows, and how that affects which API endpoints you wish to use. API Authentication & Documentation Our API accepts and returns ...
FTP integration and set up
FTP/SFTP FTP refers to ‘File Transfer Protocol’ which is an internet-based data transfer mechanism much like HTTP (Hyper-Text Transfer Protocol) which is what you would be used to seeing at the start of web addresses that you type into your browser. ...
1.a - [Shopify] Integration Demo
In this video we cover an end to end demo of our live pricing and order syncing integrations for Shopify. Below this video will be links to further articles that cover some of the topics mentioned in further detail. In order in install third party ...