Connect to Postmark Data in NetBeans

The CData JDBC Driver for Postmark integrates connectivity to live Postmark data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Postmark data in NetBeans. You will create a connection and load Postmark data in the Table Editor.

Create a JDBC Data Source for Postmark in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.api.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.api.APIDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Postmark.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

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

Query Postmark Data

To connect to Postmark data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data..