Core Features
API Endpoints
Managing and using Pulpminer API endpoints
API Endpoints
Pulpminer API endpoints are unique URLs that return JSON data from your configured webpages. This guide explains how to create, manage, and use your API endpoints effectively.
Creating an Endpoint
-
Generate JSON
- Enter webpage URL
- Get AI-generated JSON
- Customize structure if needed
-
Configure Settings
- Enable/disable caching
- Review JSON format
- Save configuration
-
Get Endpoint URL
- Endpoint format:
https://api.pulpminer.com/external/{api_id}
- Copy from dashboard
- Note the API ID
- Endpoint format:
Managing Endpoints
Dashboard Overview
Your API dashboard shows:
- All active endpoints
- Source URLs
- Cache status
- Last fetch time
- Usage statistics
Endpoint Status
Monitor each endpoint’s:
- Active/Inactive status
- Cache configuration
- Last update time
- Response format
Using Endpoints
Making Requests
Basic Request
With Error Handling
Response Format
Success Response
Error Response
Best Practices
1. Endpoint Management
- Keep endpoints organized
- Monitor usage patterns
- Update configurations as needed
- Document endpoint purposes
2. Error Handling
- Implement proper error handling
- Use retry logic
- Monitor for failures
- Log issues appropriately
3. Performance Optimization
- Enable caching when appropriate
- Monitor response times
- Track usage patterns
- Optimize request frequency
Implementation Examples
Node.js Service
Python Client
Common Use Cases
1. Content Aggregation
2. Data Monitoring
3. Data Integration
Troubleshooting
Common Issues
-
Invalid Endpoint
- Verify API ID
- Check endpoint status
- Confirm URL format
- Test with curl
-
Authentication Errors
- Verify API key
- Check header format
- Confirm key is active
- Test key separately
-
Data Issues
- Check source webpage
- Verify JSON format
- Review cache settings
- Test endpoint directly
Monitoring
Key Metrics
- Response time
- Success rate
- Error frequency
- Usage patterns
Alerts
Set up alerts for:
- Endpoint failures
- High latency
- Error spikes
- Usage thresholds
Need Help?
If you’re having endpoint issues:
- Check endpoint status
- Verify configuration
- Test with curl
- Contact support at hello@pulpminer.com