Step-by-Step Guide to Generating and Using Your SSL/TLS Certificate API Key

Introduction

We're excited to introduce API key access for streamlined SSL/TLS certificate management. This feature allows secure, direct access to a CSV file with your certificate details, bypassing the need for web portal login. Ideal for automating tracking and simplifying renewals, this guide will cover generating and using your API key efficiently and securely.

Step 1: Accessing Your Account & Generating Your API Key

Select the AP Key tab. Select the Generate an API Key for Me button (or Reset My API Key if you already have one).

You will see your new API Key in the message on successful key generation. Copy the key hash to a secure location. This will be the only time we will display it to you.

Step 2: Securely Storing Your API Key

Secure storage of your API key is essential, given its access to your organization's entire certificate catalog. Use a password manager or encrypted storage, limit access to authorized users, and avoid sharing it openly. Each user in your CertComment account can have their own API key.

Step 3: Using Your API Key to Download SSL/TLS Certificate Information

The simplest method to fetch your certificate CSV file is through a browser. Just replace YOUR_KEY with your actual key and hit enter. Your CSV file should begin to download.

Step 4: Importing the CSV File into a Spreadsheet Application

Importing the CSV file into a spreadsheet application like Google Sheets or Microsoft Excel allows for efficient management and monitoring of your certificates. Both platforms support easy importation of CSV files, enabling you to organize, analyze, and even set reminders for certificate renewals.

For Google Sheets, you can follow Google's official guide on importing CSV files.
Microsoft Excel users can refer to Microsoft's tutorial for detailed steps on CSV importation.

Using Google Sheets' IMPORTDATA Function

To use Google Sheets' `IMPORTDATA` function with your API key URL for seamless integration of your SSL/TLS certificate data, follow these simple steps:

Prepare Your API URL: Ensure your API URL is correctly formatted (remove any blank spaces) and includes the necessary parameters to authenticate using your API key.
Use the IMPORTDATA Function: In the cell where you want your data to appear, enter the `IMPORTDATA` function along with your API URL enclosed in quotes. The formula looks like this:
=IMPORTDATA("https://www.geocerts.com/certcommand/orders.csv?api_key=YOUR_KEY&status=active")
Press Enter: After entering the formula, press enter. Google Sheets will fetch the data from the provided URL and display it in the spreadsheet.

Google Sheets using IMPORTDATA() function.

Remember, anyone with access to this spreadsheet can see the URL containing your API key, so be mindful about who you share this document with. This method offers a convenient, real-time way to monitor and manage your SSL/TLS certificates directly within Google Sheets.

Filters for Refining Certificate Data Retrieval

To enhance the efficiency of managing your SSL/TLS certificates through our API, you can utilize filters in your API key URL. These filters allow you to specify the subset of certificates you wish to retrieve based on their status. The available filters include active, pending, and all, enabling you to tailor the fetched data to your specific needs.

Active Certificates (`active`): This is the default filter. When used, it returns all certificate orders that are currently active—meaning they have not been canceled, renewed, or expired for more than 30 days. It also includes any pending orders. This filter is ideal for monitoring certificates currently in use and may require attention soon.
Pending Certificates (`pending`): This filter retrieves all certificates awaiting approval or issuance. It's particularly useful for tracking new requests or certificates that are in the process of being issued but aren't active yet.
All Certificates (`all`): As the name suggests, this filter will return every certificate in your account, regardless of its status. This comprehensive view is helpful for auditing or getting an overarching view of your certificate landscape.

Using Filters in the API URL

To apply these filters, modify your API URL by appending the filter parameter at the end. For example, to fetch only active certificates, your URL might look like this:

https://yourapi.com/path/to/data?apikey=YOUR_API_KEY&filter=active

Replace "active" with "pending" or "all" as needed, based on the specific data set you wish to view. Here’s how you can structure the URL with different filters:

For active certificates: `&filter=active`
For pending certificates: `&filter=pending`
For all certificates: `&filter=all`

By effectively using these filters, you can streamline your certificate management process and ensure that you always view the most relevant data for your needs.

Contact Support

If you encounter any issues or have questions while generating and using your SSL/TLS certificate API key, our dedicated support team is here to assist you. Please visit our Contact Page for comprehensive support and contact options.

Here you can:

Open a Support Ticket: Get personalized help by submitting a detailed support request.
Email Us: Email us your queries or concerns for a quick response.
Live Chat: Chat with our support agents in real time for immediate assistance.
Phone Support: If you prefer speaking with someone, our team can answer your calls during business hours.

Our goal is to ensure you have all the support you need to manage your certificates effectively and securely. Please don't hesitate to reach out with any concerns—we're here to help!