APIs, or Application Programming Interfaces, are the fundamental tools for connecting software applications. Think of them as the bridge that allows different systems to communicate and share data seamlessly. While users often interact directly with applications, APIs operate behind the scenes, orchestrating the exchange of information. This guide dives into the specifics of integrating with PureWL’s RESTful APIs. By understanding the core concepts of APIs, you’ll be well-equipped to harness their power for your integration projects.

​
About the API

The PureWL API is a powerful tool designed to facilitate effortless integration with the PureWL Data Privacy Protection (DPP) platform. By leveraging RESTful principles, these APIs let developers add dark web monitoring, data broker opt-out, and user management to their applications. Some of the advantages of offering integration through the APIs include:

​
1 - Platform Independence

The API’s RESTful architecture ensures compatibility across multiple programming languages and platforms. Any application capable of making standard HTTP/HTTPS requests can interact with the API. Built on open standards, the API allows you to select any technology that meets your requirements, such as Java, .NET, PHP, Python, Go, and more, for integrating with PureWL.

​
2 - Ease of Integration

The application builds a RESTful request message that encodes your connection request, sends it via HTTP/S to the web service, and waits for a RESTful response message. The response contains your connection request status. Because REST over HTTPS is lightweight, building requests and parsing responses is straightforward — easy to do from scratch, and HTTP and JSON libraries are available for every major language. A request and its response handling take only a small amount of code. Integrators of the PureWL API should have a working knowledge of web services, RESTful principles, and JSON, in addition to a full understanding of how to integrate data into an application or website. All supporting software needed to support the API should be installed in a development environment prior to web service implementation. The integrator must be proficient in their selected programming language.

​
3 - Security

All communication between your application and the PureWL API is encrypted with TLS (HTTPS). Your application authenticates by exchanging its Secret Key for a short-lived Access Token, which it sends in the X-AccessToken header on every call — see Authentication. Keep the Secret Key on your server; never put it in client-side code. The rest of these guides walk you through the integration, from your first authenticated call to each DPP service.

​
Next steps

How PureWL APIs Work

Walk through the end-to-end DPP workflow, step by step.

Quickstart

Make your first authenticated API call.

Authentication

See the exact request/response shape for obtaining an Access Token.