Interactive API DocumentationΒΆ
Try out the ReputeAPI directly in your browser with our interactive Swagger UI.
Swagger UIΒΆ
The Swagger UI provides an interactive interface to explore and test all API endpoints without writing any code.
FeaturesΒΆ
π Explore EndpointsΒΆ
- Browse all available API endpoints
- View request/response schemas
- See example payloads
- Understand all parameters
π§ͺ Test RequestsΒΆ
- Try API calls directly in the browser
- No code required
- Instant response preview
- See actual API responses
π Copy CodeΒΆ
- Generate code snippets automatically
- Support for multiple languages
- Ready-to-use examples
- Copy with one click
How to UseΒΆ
Step 1: Open Swagger UIΒΆ
Go to: https://api.reputeapi.com/docs
Step 2: AuthenticateΒΆ
- Click the "Authorize" button (top right)
- Enter your API key
- Click "Authorize"
- Click "Close"
Your API key is now set for all requests!
Step 3: Try an EndpointΒΆ
- Click on an endpoint (e.g.,
GET /api/v1/check) - Click "Try it out"
- Fill in parameters (e.g.,
domain: google.com) - Click "Execute"
- View the response below!
Example: Check a DomainΒΆ
- Expand
GET /api/v1/check - Click "Try it out"
- Enter
google.comfor thedomainparameter - Click "Execute"
You'll see:
{
"domain": "google.com",
"score": 95,
"grade": "Excellent",
"spf": { ... },
"dkim": { ... },
"dmarc": { ... }
}
Alternative: ReDocΒΆ
For a more detailed, read-only API reference, use ReDoc:
https://api.reputeapi.com/documentation
ReDoc provides: - Clean, searchable interface - Better for reading documentation - Mobile-friendly layout - No testing capabilities (read-only)
OpenAPI SpecificationΒΆ
Download the raw OpenAPI spec:
https://api.reputeapi.com/openapi.json
Use this to: - Generate client libraries - Import into Postman - Create custom tooling - Validate requests
Embed Swagger in Your DocsΒΆ
Want to embed Swagger UI in your own documentation?
<!DOCTYPE html>
<html>
<head>
<title>ReputeAPI Docs</title>
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
<script>
SwaggerUIBundle({
url: "https://api.reputeapi.com/openapi.json",
dom_id: '#swagger-ui',
})
</script>
</body>
</html>
Generate Client SDKsΒΆ
Use the OpenAPI spec to generate client libraries:
PythonΒΆ
# Install OpenAPI Generator
pip install openapi-python-client
# Generate client
openapi-python-client generate \
--url https://api.reputeapi.com/openapi.json \
--output-path ./repute-client
JavaScript/TypeScriptΒΆ
npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli generate \
-i https://api.reputeapi.com/openapi.json \
-g typescript-axios \
-o ./repute-client
Other LanguagesΒΆ
See the OpenAPI Generator docs for: - Java - Go - Ruby - PHP - C# - Rust - And 50+ more languages!
Import to PostmanΒΆ
- Open Postman
- Click Import
- Select Link
- Paste:
https://api.reputeapi.com/openapi.json - Click Continue β Import
Now you have all endpoints pre-configured in Postman!
See our Postman Guide for details.
Tips & TricksΒΆ
Save Your API KeyΒΆ
After authorizing once, Swagger UI remembers your API key for the session.
Copy cURL CommandsΒΆ
After executing a request: 1. Scroll down to "Curl" section 2. Copy the generated cURL command 3. Run it in your terminal
View Response HeadersΒΆ
After executing: 1. Scroll to "Response headers" 2. See rate limit info 3. Check cache status
Test Error CasesΒΆ
Try invalid inputs to see error responses:
Next StepsΒΆ
- API Reference - Detailed endpoint documentation
- Quick Start - First API request
- Postman Guide - Use Postman for testing