How to connect with WireGuard protocol via APIs

WireGuard is a modern VPN protocol known for its simplicity, speed, and robust security. Integrating WireGuard into your application using APIs can enhance your application’s network security and performance. This guide provides a detailed technical overview of how to connect with the WireGuard protocol via APIs.

Overview

WireGuard is designed to be easy to configure and deploy, making it an excellent choice for VPN implementations. Using APIs to manage WireGuard connections can automate and streamline the process of establishing secure connections. This article covers the steps necessary to connect with the WireGuard protocol via APIs.

Prerequisites

Before proceeding, ensure you have:

1. API Access: Credentials and access to PureWL APIs.
2. WireGuard Client: Installed WireGuard client software on the device.

Steps to connect with WireGuard

By following the steps outlined in this guide, you can seamlessly integrate WireGuard into your application, automate VPN connections, and ensure a robust and secure networking experience

1. Get Access Token using the API to get an access token required for authentication. – Get Access Token
2. Get Optimized Server using the following API – Get Optimized Server
   • Request parameters:
     • X-AccessToken – You can get this from the following API – Get Access Token
     • sCountrySlug – You need to add ISO2 code from your allocated locations – Get Subscribed Countries
     • sProtocolSlug1 – You need to send “Wireguard” as a value
     • iMcs – You need to pass the value as “1”
     • sDeviceType – You can simply add “Android” here
     • sUsername – You can get it in response from Generate VPN Account
     • sPassword – You can get it in response from Generate VPN Account and have to encrypt the password using Encrypt Password API and then pass that value in this param.
     • sClientPublicKey – You can get it from the WG application 
3. Parse Configuration
   • In your response, you will get a WireGuard server with a config that needs to be parsed to the WG application
4. Create and Connect Tunnel
   • Once you have added and created a new Tunnel in the WG application using the configuration, you will be able to connect with WG

Note: The WireGuard configuration you will get from the Get Optimized Server API will only be valid for 30 minutes unless a connection is established.