From PDFServer v0.0
PDF Insights offers a greater depth of new data and analysis than you had in PDFServer. Migration to it is easy!
Quick Migration
Migrating to PDF Insights requires just a few simple changes.
Migrate /makecsv
PDF Insights has an almost-drop-in replacement for your current API call to POST /webapi/pdfconvert/makecsv
.
To migrate /makecsv
, make the following adjustments:
- Change the path to
/api/v1.5/makecsv
. - Replace
license
andproduct
fields in the request body with request headers containing the same data:Authorization: Bearer <license>
MT-Product: <pdfinsights or pdfinsightstp>
- Change handling of
startDate
andendDate
fields in the response. They are now simplyyyyy-mm-dd
strings. - Change handling of
tpreasons
. They are now text values instead of numbers. - Change handling of error messages. They are now in JSON format.
For more information, see:
Migrate /getremaining
If you make calls to POST /api/v1.0/getremaining
, make the following adjustments:
- Change the path to
/api/v1.5/getremaining
. - Change the method to
GET
. - Replace
license
andproduct
fields in the request body with request headers containing the same data:Authorization: Bearer <license>
MT-Product: <pdfinsights or pdfinsightstp>
Next Steps
Bolster Security
License codes are difficult to revoke if compromised. We strongly encourage you to switch to username/password authentication with session tokens. This transition will become mandatory in the future. To bolster security:
- Log into PDF Insights to confirm your credentials work.
- Make a first call to
GET /api/v1.5/authenticate
to receive a session token. Send two headers:Authorization: Basic base64(username:password)
MT-Product: <pdfinsights or pdfinsightstp>
- Make all other API calls with the header
Authorization: Bearer <session token>
.
The session token will be valid for 24 hours and can be used for any number of API calls.
For details, see Authentication.
Convert Multiple Files using One Endpoint
You can now use the /uploadpdfs
endpoint to convert multiple files at once. For details, see UploadPDFs.
Retrieve the MoneyThumb Scorecard
You can now use the /scorecard
endpoint to retrieve the MoneyThumb scorecard. For details, see Scorecard and Scorecard Reference.