Table of Contents
- Introduction
- API Basics
- Getting Started
- API Endpoints and Methods
- Data Handling
- Use Cases
- Security and Compliance
- Support and Resources
1. Introduction
Webbula’s API allows customers to integrate Webbula’s powerful data enhancement and hygiene services into their own applications and workflows. This API provides a set of programming instructions and standards for accessing Webbula’s web-based services, enabling customers to design products powered by Webbula’s robust data solutions.
2. API Basics
Definition of API: An Application Programmable Interface (API) is a set of programming instructions and standards for accessing a web-based software application or web tool.
Key Features of Webbula's API
- Real-time data appending and hygiene
- Multiple transmission methods (FTP and API)
- Supports both single and bulk record processing
- Secure and reliable data handling
3. Getting Started
To use Webbula’s API, you need to obtain API credentials. Contact Webbula support to request your API key and secret.
Required Credentials
- API Key
- API Secret
4. API Endpoints and Methods
List of Available Endpoints
- Data Append:
/v1/append - Email Hygiene:
/v1/emailHygiene - Social Media Authentication:
/v1/socialMediaAuth
Description of Each Endpoint
- Data Append: Matches and appends additional data points to the provided PII data.
- Email Hygiene: Analyzes and verifies email addresses to identify and mitigate potential threats.
- Social Media Authentication: Authenticates email addresses against social media profiles to verify their validity.
Example Requests and Responses
Data Append Example
POST /v1/append
{
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com"
}
Response
{
"status": "success",
"data": {
"email": "john.doe@example.com",
"age": "30",
"gender": "Male"
}
}
5. Data Handling
Input Requirements
- Proper formatting of input fields (e.g., first name, last name, email)
- Acceptable file formats: .csv, .txt
- Delimiters: pipe (|), comma (,), semicolon (;), tab
Output Formats
- JSON
- CSV
- XML
Error Handling and Troubleshooting
- Common error codes (e.g., 400 Bad Request, 401 Unauthorized)
- Suggested actions for each error code
6. Use Cases
Common Use Cases
- Gap Filling: Appending missing data points to customer records.
- Customized Targeted Marketing: Enhancing customer data for personalized marketing campaigns.
- Validation & Confirmation: Verifying the accuracy of existing data points.
Examples of Integration Scenarios
- Integrating API with web forms to auto-fill missing information.
- Using API for batch processing of large data sets.
7. Security and Compliance
Security Measures
- Data encryption during transmission
- Secure API access with keys and tokens
- Regular security audits
Compliance Considerations
- Adherence to data privacy regulations (e.g., GDPR, CCPA)
- Ensuring Can-Spam compliance for email addresses
8. Support and Resources
Contact Information for Support
- Email: support@webbula.com
- Phone: 888-993-2285