Connect your system with the Esoft API
Get Esoft API credentials and connect your own system to order, upload and receive deliveries automatically.
All plans
3 min read
The Esoft API (eWarp 3.0) lets your own system create orders, upload files, receive delivery notifications and download the edited files. The full reference is at developer.esoft.com.
Get your API credentials
Esoft provides your client ID, username and password. To ask for them, create a ticket in the Esoft Support Portal or ask your account manager. Tell us what you want to connect and which upload flow you plan to use. We review the request and send your credentials for the Development environment first.
Choose how files are uploaded
Pick one of two flows before you build:
Your system uploads the files. You attach the files to the order through the API, and we start editing as soon as they arrive. Best for automated pipelines.
Photographers upload in the Esoft Platform. Your system creates the order, then shares an upload link with the photographer. Best for on-site shoots.
Connect and test
1
Open developer.esoft.com and enter your client ID, username and password in Configure your connection.
2
Try the requests in Mock mode. It returns example responses, so you can explore safely.
3
Agree on a callback URL and format (GET or POST) with Esoft, so we can notify you when orders are created and delivered.
4
Test the full flow on the Development environment, then switch to Production.
Enter your credentials, then try requests in Mock mode.
Warning
The API key is your username and your password, base64-encoded. Don’t hash the password, or every request fails with a 401 error.
The Authorization header combines your username and base64-encoded password.
What happens next
When your integration works on Development, switch to the Production URL and go live. For every endpoint and the go-live checklist, see Gotchas & checklist on developer.esoft.com.