Authentication

You'll need to authenticate your requests to access any of the endpoints in the Pdftools Cloud API. In this guide, we'll look at how authentication works. This document provides an overview of how to authenticate your requests to our API using API keys.

Authentication Method

Our API employs API key authentication to ensure secure access to our services. API keys are unique strings that are passed along with each request to authenticate the user.

Generating API Key

To obtain an API key, follow instructions on the account creation page.

Authenticating Requests

Include the header X-Api-Key to properly authorize your API calls.

  • Name
    X-Api-Key
    Type
    string
    Type
    Optional
    Description

    Substitute <API-KEY-VALUE> with the value of your API key.

X-Api-Key: <API-KEY-VALUE>

Security Considerations

Keep Your API Key Secure: Treat your API key like a password. Do not share it with anyone who should not have access to your account.

Use HTTPS: Always use HTTPS when making requests to our API to ensure that your API key remains secure during transmission.

Rate Limiting

To prevent abuse and ensure fair usage of our API, rate limiting is enforced. If you exceed the allowed number of requests, you will receive a 429 Too Many Requests response.

Conclusion

In conclusion, API key authentication provides a simple yet effective way to secure access to our API. By following the guidelines outlined in this documentation, you can successfully authenticate your requests and leverage our services.

If you have any questions or need further assistance, please don't hesitate to contact our support team. We're here to help!

Was this page helpful?