{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Connect API Documentation","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"https://eservices.easypost.eu/logo.af033df6a3a3ab7ef1affbbc54789a2b.svg","alt":"Connect platform","withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"connect-api-documentation","__idx":0},"children":["Connect API Documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This documentation provides a comprehensive overview of our API, which allows for automated interaction with our platform."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API is designed to streamline your workflow management and document processing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here’s a more polished and professional version of your paragraph:"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"environment-specific-api-domains","__idx":1},"children":["Environment-Specific API Domains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To facilitate integration testing and ensure smooth adoption, the API is available in two environments: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Acceptance (ACC)"]}," for validation and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production (PRO)"]}," for live operations."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API Domain"},"children":["API Domain"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACC"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://acc.eservices.easypost.eu"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://eservices.easypost.eu"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The setup of credentials to make authenticated calls to the API are detailed in the dedicated page ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"core-functionality","__idx":3},"children":["Core Functionality"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"monitoring--tracking","__idx":4},"children":["Monitoring & Tracking"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Without any additional configuration, you can immediately use the API to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monitor the status of all your Jobs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monotor the status and the full track & trace of all the Sendings"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"job-submission-process","__idx":5},"children":["Job Submission Process"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To submit new jobs through the API:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow Configuration (Prerequisite)"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure your workflow(s) in the Web Platform"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Define necessary tasks (ERDS channel, Email Channel, Print&Send fallback, ...)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Obtain the workflow ID, which is required for job submission"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow Validation"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the workflow endpoint to verify that your workflow is properly validated"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only validated workflows can be used for job submission"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Document Submission"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The submission is a two-step process:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call the prepare endpoint ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/single-file"]}," with required metadata."," ","Upon valid request, you will receive a response containing an upload URL ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUploadUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Upload your file (PDF document, or XML, CSV file depending on the workflow configuration) by performing an HTTPS PUT call on the URL ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUploadUrl"]}," embedding the file as a binary stream."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example cURL request on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUploadUrl"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT -T \"/path/to/file\" \"fileUploadUrl\"\n","lang":"bash"},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"detailed-api-reference","__idx":6},"children":["Detailed API Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The complete API specification is available in the OpenAPI format, accessible through the following link:"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/public-api-production/openapi"},"children":["OpenAPI Specifications"]},"."," ","This specification details all available endpoints, request/response formats, and authentication requirements."]}]},"headings":[{"value":"Connect API Documentation","id":"connect-api-documentation","depth":1},{"value":"Environment-Specific API Domains","id":"environment-specific-api-domains","depth":3},{"value":"Authentication","id":"authentication","depth":2},{"value":"Core Functionality","id":"core-functionality","depth":2},{"value":"Monitoring & Tracking","id":"monitoring--tracking","depth":3},{"value":"Job Submission Process","id":"job-submission-process","depth":3},{"value":"Detailed API Reference","id":"detailed-api-reference","depth":2}],"frontmatter":{"seo":{"title":"Connect API Documentation"}},"lastModified":"2026-06-08T14:11:03.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}