Get started with Basware SmartPDF API

The Basware SmartPDF API is a REST API integration method that allows users to upload PDF documents to the SmartPDF document flow. With this API, SmartPDF customers can upload all their PDF documents, including those not received via email. 

Prerequisites

To access Basware SmartPDF API you need API access keys. These will be provided by your Basware SmartPDF delivery project consultant or your technical partner manager. The key can be fetched from Basware SmartPDF configuration tool. 

Try it out

This example posts a new PDF document to Basware SmartPDF. To interact with the API you can use any tool capable of posting HTTP messages, such as Postman or curl. This example uses Postman. 

Send the above payload to Basware API:

POST to URL: https://api.basware.com/v1/smartpdf/invoiceUpload

• Enter your API access key to request header parameter ‘x-api-key'.  
• Send the JSON from above payload in message body.

The above settings use Basware API environment in European region, which is the only available region for SmartPDF APIs. End part of the URL 'v1/smartpdf/invoiceUpload' determines the API being executed. Use Content-type: application/json. You need to change the values of the fields in message payload to match your document to be uploaded to Basware SmartPDF. 

In response you should get a '200 OK' and in response body a pre-signed URL, where the actual PDF file can be uploaded with POST request.

Where to next?

If you are considering using Basware SmartPDF API in your projects, you might want to find out how well you can program the web service calls required for using the API from your ERP system or integration platform.  

If you want to dive deeper into the API functionality itself, please check out the SmartPDF API reference for supported methods or the SmartPDF API manual for most common usage scenarios and common considerations.