Overview
- The Optimum Parcel SFTP API lets you manage secure file transfer configurations and credentials. You can develop applications that integrate with Optimum Parcel to automate the exchange of large datasets, ensuring that reports and shipping data are securely delivered to external servers for processing.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and SFTP services.
Optimum Parcel App
Optimum Parcel’s SFTP services give users the ability to define secure endpoints for data dumps, allowing for the automated push and pull of files between the platform and internal enterprise systems.
Optimum Parcel API
The REST API that allows users to create, update, and validate SFTP connection profiles from within your app.
Credential Management
A system that securely stores authentication details, such as login credentials and SSH keys to ensure that automated connections remain authenticated without exposing sensitive secrets.
Connection Testing
A mechanism that validates connectivity to the specified host and checks for firewall issues or credential errors before the activation of a transfer automation.
What can users do with the Optimum Parcel SFTP API?
Users can use the Optimum Parcel SFTP API to perform common workflows, such as:
- Create a new SFTP connection profile
- Update credentials for an existing server
- Test connectivity to a remote host
- Define specific directory paths for file uploads
- List all configured SFTP destinations
- Delete obsolete connection profiles
SFTP properties available to create, modify, update and delete through the Optimum Parcel SFTP API:
- Connection Status
- Credentials
- Host Details
- Port Configurations
- Remote Paths
