Test your BOD connection with Postman

Overview

This page explains how to verify the successful processing of your BOD (Business Object Document) using Postman. You will test the relevant API endpoint by sending a request with your BOD mapping file. Follow the steps below to complete the process.

Accessing Your API Key and BOD Mapping File

Retrieving Your API Key

1. Go to Settings → Global Settings → Integration & SSO.

   
2. You can either manually copy your API key or click the copy button to copy it to your clipboard.

   

Downloading the BOD Mapping File

1. Go to Settings → Document Processing → Export.

   
2. In the Actions column of the relevant export entry, click the three-dot menu and select Edit.

   
3. Locate the BOD Mapping File and click the Download button to save it.

   

Test the Endpoint in Postman

1. Paste the cURL Command in Postman

   Open Postman and paste the following cURL command into the Import section. Postman will automatically configure the request.

   Copy

   curl -X 'POST' \
     'https://api.docbits.com/prod-api/import/purchase_order_bod' \
     -H 'accept: application/json' \
     -H 'X-API-KEY:' \
     -H 'Content-Type: multipart/form-data' \
     -F 'org_id=' \
     -F 'sub_org_id=' \
     -F '[email protected];type=text/xml' \
     -F 'custom_fields_mapping='

   

   
2. Set the API Key Go to the Headers tab, locate the X-API-KEY header, and paste your API key into the Value column.

   
3. Upload the BOD File Go to the Body tab, locate the file key, then click Select Files in the Value column and upload your BOD XML file.

   
4. Send the Request Click Send to make the API call.

   
5. Verify the Response Check the response to confirm that your BOD was processed successfully.