Blog

How to use Api2Pdf’s SwaggerHub to get the most out of our support team

Published Jul 21, 2018

Our documentation at https://v2.api2pdf.com is built on swagger and so you are able to use the documentation itself to validate your API calls.

Step 1

Make sure you have your API key at the ready from portal.api2pdf.com. On our documentation page, click the Authorize button. Enter your API key in either field or both fields. We support both query string and Authorization header authentication methods.

If you do this properly, you should see the lock icon like so:

Step 3

Open up your desired API call that you plan to use and click Try it out.

Step 4

Edit the Payload to your specifications for the API call and then click Execute.

You should see the result like so:

Getting Support

If you are having an issue with an API call and require support from the Api2Pdf developer team, please contact [email protected] and include the following details:

Brief summary of the issue and what you are trying to accomplish
Endpoint you are testing
Your payload body
Error you are getting

It is most helpful to include the JSON payload by formatting it first on jsonlint.com and then pasting it to https://gist.github.com

From there we should be able to dig into the problem and help come up with a solution quickly. But you may find by virtue of testing out the API calls with SwaggerHub, you can solve it yourself!

Thanks,

-Api2Pdf Developers