7A / DEVELOPER PLATFORM REST API V1.0
Developer API Suite
Enterprise security scanning, Core Web Vitals telemetry, and developer utilities. Build automated workflows, schedule recurring security sweeps, and power your custom applications with high-throughput REST endpoints.
01 / PLATFORM OVERVIEW
Overview & Capabilities
The 7AZZANI API provides programmatic access to our suite of security scanning, performance auditing, and web utility tools. Build powerful integrations, automate continuous security posture checks, and monitor website speed at scale.
Security Scanner
Detect vulnerabilities, SSL/TLS misconfigurations, malware patterns, and HTTP header anomalies.
Performance Testing
Measure bandwidth, latency, jitter, and Core Web Vitals with precise network diagnostics.
Web Utilities
Programmatic URL shortening, custom QR generation, WHOIS/DNS intelligence, and image optimisation.
Why Choose the 7AZZANI API?
- Enterprise-Grade Engine: Multi-vector security testing and actionable remediation advice.
- Low Latency REST: Instant execution with high-throughput response streaming and polling workflows.
- Comprehensive JSON Schemas: Fully documented payloads compatible with modern API client generators.
- Community & Free Access: Developer-first access with generous burst allowances and zero paywalls.
02 / INTEGRATION WORKFLOW
Getting Started & Authentication
Developer API Access is 100% Free
Create a free developer account and start building immediately. No credit card required, with generous production rate limits.
Create an Account
Sign up for a free 7AZZANI account to access the developer console and manage API credentials:
New Developer
- Visit the signup page
- Enter your email and create a secure password
- Verify your email address
- Generate your first production API key
Existing Account
Already registered on 7AZZANI? Log in directly to view or create keys.
Generate Your API Key
After logging in, navigate to your API keys dashboard to issue an authentication token:
- Go to the API Dashboard
- Click "Create New Key"
- Assign a recognizable label (e.g.,
Production App,CI/CD Scanner) - Optionally restrict access by CIDR / IP address for zero-trust security
- Store your issued key (prefixed with
7AZ_)
Security Advisory:
- • API keys are shown once upon creation and cannot be retrieved later.
- • Never commit API keys to public repositories or client-side bundles.
- • Pass credentials securely via environment variables (
7AZZANI_API_KEY). - • If a token is compromised, revoke it immediately from your API Dashboard.
Make Your First Request
Authenticate your requests by passing the Bearer token in the Authorization header:
curl -H "Authorization: Bearer 7AZ_YOUR_API_KEY" \
https://7azzani.com/api/scans/statistics/
Every API request must include the Authorization: Bearer 7AZ_... header (except open image tools).
✓ Verified Response (200 OK):
{
"total_scans": 42,
"completed_scans": 38,
"vulnerabilities_found": 156,
"critical_issues": 12
}
Services Included
Security Scanner
Comprehensive website CVE & vulnerability auditing
Speed Test
Network speed, latency, and throughput testing
URL Shortener
Fast link compression and click analytics
Domain Lookup
WHOIS registry intelligence and DNS record parsing
QR Code Engine
Dynamic custom QR generation and asset export
Image Tools
Data URI encoding, optimisation, and format conversion
03 / ENDPOINT CATALOG
API Endpoints & Schemas
Import into Swagger, Postman, or Insomnia
Production Base URL:
https://7azzani.com
🛡️ Security Scanner
Scan websites for vulnerabilities, security issues, and misconfigurations.
/api/scans/
List all your security scans
/api/scans/quick_scan/
Perform a quick security scan
View Request/Response
Request Body:
{
"url": "https://example.com",
"scan_type": "quick" // Options: "quick", "standard", "deep"
}
Response (201 Created):
{
"scan_id": "abc123-def456",
"url": "https://example.com",
"status": "scanning",
"status_url": "/api/scans/abc123-def456/status/"
}
/api/scans/{id}/status/
Check scan status and progress
/api/scans/{id}/report/
Get detailed vulnerability report
/api/scans/statistics/
Get overall scanning statistics
⚡ Speed Test
Run network speed tests and measure bandwidth, latency, and jitter.
/speedtest/api/v1/run/
Run a network speed test
View Request/Response
Response (200 OK):
{
"test_id": "speed-789xyz",
"download_speed": 95.4,
"upload_speed": 45.2,
"ping": 12,
"jitter": 3.2,
"server_location": "New York, US"
}
/speedtest/api/v1/history/
Get your speed test history
/speedtest/api/analytics/
Get speed test analytics and trends
🖼️ Image Tools
Encode images to Base64 Data URIs, re-encode them smaller, and inspect a Data URI you were handed.
No key needed60 requests/hour by IP without a key, 600/hour with one. Nothing you send is stored. Scope these keys with the service image_tools.
/api/image/encode
Encode an image to a Data URI, with a recommendation on whether to inline it
View Request/Response
Request — one of file (multipart), url, or data:
curl -F file=@logo.png -F optimise=true -F width=192 \
https://7azzani.com/api/image/encode
Response (200 OK):
{
"ok": true,
"source": { "mime": "image/jpeg", "bytes": 920311, "width": 1600, "height": 1067 },
"output": { "mime": "image/avif", "bytes": 1139, "width": 192, "height": 128,
"data_uri": "data:image/avif;base64,AAAAIGZ0eXBh..." },
"candidates": [ { "mime": "image/avif", "bytes": 1139 },
{ "mime": "image/webp", "bytes": 1596 } ],
"skipped": { "image/png": "lossless PNG cannot compete on a photograph" },
"advice": { "verdict": "inline", "reasons": [ "..." ] },
"timing_ms": 65.3
}
Options: optimise, width, quality, formats (webp, avif, jpeg, png), scrub for SVG.
/api/image/optimize
Re-encode smaller and return the bytes, without the Base64 envelope
/api/image/decode
Report what a Data URI actually contains, read from its bytes rather than its declaration
/api/image/formats
What this server reads and writes, current limits, and the inlining thresholds
A url is fetched through a guard that refuses loopback, private and cloud-metadata addresses and re-checks after every redirect. HEIC is recognised but not decoded: this build has no HEIF plugin.
🔗 URL Shortener (ShrinkIt)
Create shortened URLs with analytics and tracking.
/shrinkit/api/shorten/
Create a shortened URL
View Request/Response
Request Body:
{
"url": "https://example.com/very/long/url/here",
"custom_code": "mylink" // Optional
}
Response (201 Created):
{
"short_url": "https://7azzani.com/s/mylink",
"short_code": "mylink",
"original_url": "https://example.com/very/long/url/here",
"created_at": "2024-01-15T10:30:00Z"
}
/shrinkit/api/toggle/{url_id}/
Enable/disable a URL
/shrinkit/api/delete/{url_id}/
Delete a shortened URL
/shrinkit/{short_code}/stats/
Get click statistics for a URL
🌐 Domain Lookup
Perform WHOIS lookups and DNS record analysis.
/lookup/api/lookup/
Perform domain/IP lookup
View Request/Response
Request Body:
{
"domain": "example.com",
"lookup_type": "all" // Options: "whois", "dns", "all"
}
Response (200 OK):
{
"domain": "example.com",
"registrar": "Example Registrar Inc.",
"created_date": "1995-08-14",
"expiry_date": "2024-08-13",
"dns_records": {
"A": ["93.184.216.34"],
"MX": ["mail.example.com"]
}
}
/lookup/history/
Get your lookup history
📱 QR Code Generator
Generate customizable QR codes with tracking and analytics.
/qr/api/preview/
Generate QR code preview
View Request/Response
Request Body:
{
"qr_type": "url",
"content": "https://example.com",
"style": {
"color": "#000000",
"background": "#FFFFFF"
}
}
Response (200 OK):
{
"preview_url": "/media/qr/preview_abc123.png",
"qr_code_base64": "data:image/png;base64,..."
}
/qr/api/content-form/{qr_type}/
Get form fields for QR code type
Types: url, text, email, phone, wifi, vcard
⚠️ Error Responses
Common error responses across all endpoints:
{
"error": "Authentication required",
"message": "Please provide a valid API key"
}
{
"error": "Rate limit exceeded",
"message": "Maximum 10 requests per second",
"retry_after": 1
}
{
"error": "Invalid request",
"message": "URL is required"
}
04 / TRAFFIC POLICIES
Rate Limits & Quotas
Understanding Rate Limits
Rate limits prevent API abuse and ensure fair usage for all customers. Limits are applied per API key and reset automatically.
| Limit Type | Quota | Description |
|---|---|---|
| Per Second | 10 requests | Maximum burst rate for short-term traffic |
| Per Minute | 100 requests | Sustained traffic limit |
| Daily/Monthly | Unlimited | No caps on total usage volume |
Rate Limit Headers
Every API response includes headers with your current rate limit status:
-
X-RateLimit-LimitYour rate limit -
X-RateLimit-RemainingCalls remaining -
X-RateLimit-ResetReset time (Unix timestamp)
Handling Rate Limits
When you exceed a rate limit:
- • You'll receive a
429 Too Many Requestsresponse - • Check the
Retry-Afterheader for wait time - • Implement exponential backoff in your code
Pro Tip: Monitor your usage in real-time from your API Dashboard to avoid hitting rate limits unexpectedly.
05 / INTEGRATION EXAMPLES
Code Examples
cURL Examples
Quick Security Scan:
curl -X POST https://7azzani.com/api/scans/quick_scan/ \
-H "Authorization: Bearer 7AZ_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'
Check Scan Status:
curl -H "Authorization: Bearer 7AZ_YOUR_API_KEY" \
https://7azzani.com/api/scans/{scan_id}/status/
06 / SDK REFERENCE
Developer Guide & SDKs
SDK Examples
Ready-to-use code snippets for popular languages:
# Install: pip install requests
import requests
API_KEY = "7AZ_your_api_key_here"
BASE_URL = "https://7azzani.com"
headers = {
"Authorization": f"Bearer {API_KEY}",
"Content-Type": "application/json"
}
# Security Scan
def run_security_scan(url):
response = requests.post(
f"{BASE_URL}/api/scans/quick_scan/",
headers=headers,
json={"url": url, "scan_type": "quick"}
)
return response.json()
# URL Shortener
def shorten_url(long_url):
response = requests.post(
f"{BASE_URL}/shrinkit/api/shorten/",
headers=headers,
json={"url": long_url}
)
return response.json()
# Domain Lookup
def lookup_domain(domain):
response = requests.post(
f"{BASE_URL}/lookup/api/lookup/",
headers=headers,
json={"domain": domain, "lookup_type": "all"}
)
return response.json()
# Usage example
result = run_security_scan("https://example.com")
print(f"Scan ID: {result['scan_id']}")
Best Practices
Security
- • Store API keys in environment variables
- • Never expose keys in client-side code
- • Use IP restrictions when possible
- • Rotate keys periodically
Performance
- • Implement request caching
- • Use async/await for parallel requests
- • Handle rate limits gracefully
- • Use polling for long operations
Error Handling
- • Always check response status codes
- • Implement retry logic with backoff
- • Log errors for debugging
- • Gracefully handle 429 errors
Polling Pattern
- • Start scan/test operation
- • Poll status endpoint at intervals
- • Use exponential backoff
- • Stop when status is "completed"
Handling Rate Limits
Example of implementing retry logic with exponential backoff:
import time
import requests
def make_request_with_retry(url, headers, data, max_retries=3):
for attempt in range(max_retries):
response = requests.post(url, headers=headers, json=data)
if response.status_code == 429:
retry_after = int(response.headers.get('Retry-After', 2 ** attempt))
print(f"Rate limited. Waiting {retry_after} seconds...")
time.sleep(retry_after)
continue
return response
raise Exception("Max retries exceeded")
07 / FREQUENTLY ASKED QUESTIONS
Frequently Asked Questions
Yes! The 7AZZANI API is completely free for developers. We believe in open access to security and performance tools. There are no hidden fees, credit cards required, or trial periods.
If you find the project useful, you can support our development through optional contributions.
We maintain generous rate limits to ensure service stability for everyone:
- 10 requests per second (burst)
- 100 requests per minute (sustained)
- Unlimited monthly requests
Need higher limits for a dedicated enterprise workload? Contact our engineering team.
Authentication uses standard HTTP Bearer tokens:
- Create an account and navigate to the API Dashboard
- Generate a new API key
- Pass it in your HTTP headers:
Authorization: Bearer 7AZ_...
We prioritize zero-trust security:
- All network traffic is encrypted via HTTPS / TLS 1.3
- API keys are cryptographically hashed and encrypted at rest
- Scan payloads are processed in memory and not retained permanently
- Optional CIDR/IP whitelisting to lock your tokens to your infrastructure
Yes! You are fully licensed to use the 7AZZANI API in both personal and commercial applications. There are no licensing fees, royalties, or proprietary lock-in.
7AZZANI is community-driven and open:
- Report bugs, propose features, or submit pull requests
- Improve documentation and SDK examples
- Participate on our developer leaderboard and community forums
08 / GOVERNANCE & POLICIES
API Terms of Use & Acceptable Policy
Last updated: November 15, 2026
1. Acceptable Use
By using the 7AZZANI API, you agree to:
- Only scan websites you own or have explicit permission to test
- Not use the API for illegal, harmful, or malicious purposes
- Not attempt to disrupt, damage, or gain unauthorized access to our services
- Comply with all applicable laws and regulations
- Not reverse engineer or attempt to derive the source code of our API
2. Rate Limits & Fair Use
To ensure quality service for all users:
- You must respect the global rate limits
- Systematic attempts to circumvent rate limits may result in suspension
- We reserve the right to throttle or block excessive usage
3. API Key Security
You are responsible for maintaining the security of your API keys:
- Keep your API keys confidential and secure
- Do not share API keys publicly or commit them to version control
- Immediately notify us if you suspect unauthorized use
- You are liable for all usage under your API keys
- We may revoke compromised keys without notice
4. Data & Privacy
How we handle data:
- Scan results are retained for 90 days for your reference
- We do not sell or share your scan data with third parties
- You retain ownership of your scan targets and results
- We may collect anonymized usage statistics for service improvement
- Full privacy policy available at 7azzani.com/privacy
5. Service Level & Availability
Our service commitments:
- We strive for 99.9% uptime but do not guarantee uninterrupted service
- Scheduled maintenance will be announced 24 hours in advance
- We are not liable for issues beyond our reasonable control
6. Prohibited Activities
The following activities are strictly prohibited:
- Scanning government or military websites without authorization
- Testing for vulnerabilities to exploit rather than report
- Automated scanning of third-party websites without permission
- Using scan results to harm, defame, or harass others
- Reselling or redistributing API access
- Creating derivative works based on our API
7. Limitation of Liability
THE API IS PROVIDED "AS IS" WITHOUT WARRANTIES OF ANY KIND. IN NO EVENT SHALL 7AZZANI BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OF THE API, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
8. Termination
We may terminate or suspend your access:
- For violation of these terms
- For suspected fraudulent or illegal activity
- Upon your request
Upon termination, your API keys will be revoked and you must cease all use of the API.
9. Changes to Terms
We may update these terms at any time. Continued use of the API after changes constitutes acceptance of the new terms. Material changes will be notified via email or dashboard announcement.
Questions?
For questions about these terms or the API, contact us at: