How To Use GlockApps v2 API: Step-by-Step Tutorial

Estimated reading time: 6 minutes

Designed to streamline processes for developers, email marketing companies, and organizations focused on automation, the API facilitates seamless integration and efficient task execution. This article explores the key functionalities, use cases, and step-by-step guidance on utilizing the GlockApps v2 API, where we show how to harness its full potential for enhancing productivity and accuracy.

What is an API and Why You Should Use It

An API (Application Programming Interface) is a structured interface that enables seamless communication between different software components.

The primary objective of an API is to streamline the integration of services and applications by providing developers with direct access to the features of GlockApps v2. This facilitates the automation of data analysis and verification processes, while also enabling the delivery of testing results to your partners and clients efficiently.

The GlockApps v2 API grants access to powerful tools for spam filter testing, email deliverability analysis, DNS record validation, and more. It supports the automation of project and folder creation, test execution (both manual and automated), and data retrieval from test results, enhancing accuracy.

Key use cases for the API include:

• Software Developers: To build integrations between GlockApps v2 and third-party services or applications.
• Email Marketing Companies: To maximize the efficiency and reliability of email campaigns through automated testing and analysis.
• Organizations Focusing on Process Automation: To integrate GlockApps v2 into existing systems and automate critical tasks such as spam filter testing, email deliverability analysis, and related operations.

How to Use the Documentation

The API documentation, provided via Swagger, is an essential tool for working with the GlockApps v2 API.

It contains comprehensive descriptions of available methods, endpoints, parameters, response formats, and example requests. The documentation is organized around the following key components:

Endpoints

Each endpoint describes a specific action you can perform (retrieving a list of projects or creating a new test).

Request Methods

The core methods supported by the API include GET, POST, PUT, PATCH, and DELETE, each serving a distinct purpose:

• GET: Retrieves data from the server. They are commonly used for fetching lists of projects, tests, reports, etc. Requires API Access permissions.
• POST: This function creates new resources, such as projects, folders, or manual tests. It requires API Write Access permissions.
• PUT: Fully updates existing resources, such as modifying project or folder details. Requires API Write Access permissions.
• PATCH: Partially updates resources, allowing changes to specific fields. For example, you can activate/deactivate automated tests, move tests between folders, or add custom notes to tests. Requires API Write Access permissions.
• DELETE: Removes entities, such as projects, folders, or test reports. Requires API Write Access permissions.

Access Rights

Access to API methods depends on user permissions:

• GET is available with an Enterprise plan (API Access).
• POST and other write operations require corporate plans (API Write Access).
• Free accounts do not have API access.

API Key

An API key is required to interact with the API, which can be found in your account settings. It must be included in the request header:

x-api-key: <your_api_key> 

Request Format

All requests must be sent over HTTPS, with data transmitted in JSON format.

If you adhere to these guidelines, you can effectively utilize the GlockApps v2 API for a wide range of email deliverability and automation tasks.

Methods for Making API Requests

There are several ways to execute requests to the GlockApps v2 API, including Swagger UI, cURL, Postman, and other tools:

Swagger UI

An interactive tool integrated into the documentation, allowing you to send requests and view results directly from your browser without the need for coding.

cURL

A command-line utility for making HTTP requests, ideal for use in scripts and terminal environments.

Postman

A popular API testing tool that enables you to send requests, configure parameters, and analyze responses.

Example of Using the API

This example demonstrates the process of creating a manual test.

Step 1: Obtain an API Key

Retrieve your API key from your account settings.

Step 2: Retrieve the Project ID

To create a test, you first need to identify the project ID of the relevant project. Use the following GET request with your API key:

curl -X GET https://api.glockapps.com/gateway/spamtest-v2/api/projects \ -H ‘x-api-key: <your_api_key>’

The response will include details about your projects, including their unique identifiers (projectId). In that case, we got projectId = 16

Video Examples:

Step 3: Retrieve the List of Providers

Next, fetch the list of available providers using the following GET request:

curl -X GET https://api.glockapps.com/gateway/spamtest-v2/api/providers \ -H ‘x-api-key: <your_api_key>’

The response will return available provider groups and seed accounts.

Video Examples:

Step 4: Creating a Manual Test

Knowing the project ID and selecting, for example, the providers AOL (“providerGroupId”: “2”) and Outlook (“providerGroupId”: “3”), you can create a template for a manual test with the following command: 

curl -X POST https://api.glockapps.com/gateway/spamtest-v2/api/projects/<your_projectId>/manualTest \ -H ‘Content-Type: application/json’ \ -H ‘x-api-key: <your_api_key>’ \ -d ‘{ “providerGroupIds”: [“2”, “3”], “testType”: “ManualTest” }’

Video Examples:

Step 5: Completing the Test

To complete the test and retrieve the results, send an email to the provided email addresses, including the testID in the email body.

Conclusion

The GlockApps v2 API is an essential tool for businesses and developers seeking to optimize email deliverability and streamline operational workflows. The API supports diverse use cases by offering comprehensive documentation, robust endpoint capabilities, and flexible request methods, from integrating third-party services to automating spam filter tests. Whether you’re a software developer, email marketer, or automation-focused organization, mastering the GlockApps v2 API can significantly enhance your processes. 

Don’t waste any time – get started with GlockApps v2 API today!

FAQ