Manage Postmark Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Postmark seamlessly integrates Postmark data into database management tools like DBArtisan by enabling you to access Postmark data as a database. This article shows how to create a JDBC source for Postmark in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Postmark Data into DBArtisan Projects

Follow the steps below to register Postmark data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   Using API Key Authentication

   Postmark uses server API tokens to authenticate requests. Each Postmark server has its own API token, which controls access to messages, bounces, templates, and statistics associated with that server.

   To obtain your Server API Token, log in to your Postmark account and navigate to the server you want to connect to. Go to API Tokens under the server settings and copy the token labeled Server API token.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Postmark Server API Token. This value is sent as the X-Postmark-Server-Token header on every request.

   Example connection string:

   Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
   

   Connecting to Postmark

   Once the authentication is configured, you can connect to Postmark and query data from any of the available tables such as OutboundMessages, Bounces, and Templates.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Postmark JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"

6. Finish the wizard to connect to Postmark data. Postmark entities are displayed in the Datasource Explorer.

You can now work with Postmark data as you work with any other database. See the driver help documentation for more information on the queries supported by the Postmark API.