Skip to main content

​
Obtain your API key

The Email API client requires one credential:
  • API key: a secret token that authenticates your requests
It is available in the Paubox dashboard under API Credentials.

​
Create a config.cfg file

Create a config.cfg file in your project directory:
The SDK reads this file automatically via Config::General when you instantiate the client; no constructor arguments are needed:
The constructor dies immediately if API_KEY is missing from the config file, so credential errors are caught at startup. The SDK sets the Authorization header on every request:

​
Forms client

Paubox_Forms_SDK requires no credentials. Form submissions are associated with the form ID, not an API key.

​
Security notes

  • Do not commit config.cfg to source control. Add it to your .gitignore.
  • The SDK does not expose credentials in error messages or logs.