Quick Start Guide
Get started in under 2 minutes
Prerequisites
You'll need a Snappkit account. Don't have one?Sign up for freeand get 100 credits to start.
1
Sign Up for an Account
Create a free account to get started. You'll receive 100 free credits upon signup (enough for 100 basic screenshots).
- Visit thesign-up page
- Enter your email and create a password
- Verify your email address
- You're ready to go!
2
Get Your API Key
Once you're logged in, navigate to your dashboard to generate an API key.
- Go to yourDashboard
- Click on"API Keys" in the sidebar
- Click"Generate New Key"
- Give your key a name (e.g.,"Production","Testing")
- Copy your API key and store it securely
Keep Your API Key Secret
Your API key grants access to your account. Never share it publicly or commit it to version control. Use environment variables to store it securely.
3
Make Your First Request
Now you're ready to capture your first screenshot! Here's a simple example using cURL:
curl -X POST https://snappkit.com/api/screenshot \
-H"Authorization: Bearer YOUR_API_KEY" \
-H"Content-Type: application/json" \
-d'{
"url":"https://example.com"
}' \
--output screenshot.pngReplace YOUR_API_KEY with your actual API key.
Success!
You should now have a screenshot.png file containing a screenshot of example.com at 1920x1080 resolution.
4
Customize Your Screenshot
The API supports many customization options. Here's an example with more parameters:
curl -X POST https://snappkit.com/api/screenshot \
-H"Authorization: Bearer YOUR_API_KEY" \
-H"Content-Type: application/json" \
-d'{
"url":"https://example.com",
"width": 1280,
"height": 720,
"format":"jpeg",
"quality": 90,
"device":"mobile",
"fullPage": true,
"delay": 2000
}' \
--output screenshot.jpgThis request will:
- Capture the entire page (scrollable content)
- Use mobile device emulation
- Wait 2 seconds for JavaScript to execute
- Export as JPEG with 90% quality
- Use a 1280x720 viewport
What's Next?
Ready to Build?
You now have everything you need to start integrating screenshot functionality into your application. Happy coding!