Welcome to Poper, your AI-driven popup builder application. This article will guide you through the process of setting up and authenticating your API key.
Step 1: Obtain an API Key from Poper
Your journey starts with getting an API key from Poper. This unique identifier will allow you to create your popups via API requests.
Step 2: Make your API Requests
All your API requests will be POST requests. With every request, make sure to include an 'api_key' key in the body of your request, along with your API key. As long as your 'api_key' is valid, your requests will be processed without problems.
The base URL for Poper API is https://api.poper.ai/general/v1. This is where you will submit your POST requests.
Step 3: Test your Authentication Key
Once you got your API key and started making requests, it's time to test the authentication. For this, you can send a post request to https://api.poper.ai/general/v1/ping. Remember to include the 'api_key' in the body.
Ensure that you use "x-www-form-urlencoded" as the media type.
Here's an example of how you'd set up the curl request:
curl -X POST https://api.poper.ai/general/v1/ping -H 'Content-Type: application/x-www-form-urlencoded' -d 'api_key=YOUR_API_KEY'
Step 4: Confirmation of API key Authentication
After the test request, you should receive a response similar to:
{ message: "Pong!", email: <your-authenticated-email>, }
If you received this message, it verifies that your API key is authenticated. This means your API key is valid and you're ready to start making authorized requests and enhance your business.