Authentication

The Visual PDF API is only accessible to registered users.

If you have an account, you must create an API key from your admin portal, by going to "Settings", then clicking on the "New" button in the "API keys" section.

This key will be used in all your calls to the API, to identify you and prove that you have the right to use it.

You can create different keys, for your different projects.

Your API keys must be protected because they allow you to be identified in the eyes of the API. Someone who obtains your key could fraudulently use your account and use your credits. Never share your API keys publicly, whether on a Git repository (GitHub, GitLab, etc.) or on client-side code.

Using the API key

Your API key must appear in each request headers via the Authorization header like this: Authorization: Bearer {your_API_key}.

    
      await fetch(
        'https://api.visualpdf.com/v1/process',
        {
          method: 'POST',
          body: form,
          headers: {
            Authorization: `Bearer ${your_API_key}`,  // Replace ${your_API_key} with the key created in your admin panel
          }
        },
      )
    
  

Testing authentication

If you want to test your authentication and your API key, you can use the service status endpoint, that will respond with a success message when your authentication is successful.