Validate API Credentials
Before using the API, authenticate your credentials by calling the POST /auth endpoint. A successful response will include:
A bearer token for secure API access
A timestamp indicating when the token expires
Verify Authentication and Access to Services
Ensuring Reliable Service Access
Endpoint:
GET /healthcheckUse Case: Regularly check API availability to avoid service disruptions
Outcome: Ensures seamless integration by confirming API operational status
Validate Credential Token Authentication
Endpoint:
POST /authUse Case: Automate credential validation and token generation
Outcome: Enhances security and streamlines authentication for scheduled tasks
Reporting API Credential Authentication and Health Check
The Reporting Credential Authentication and Health Check API verifies credentials and ensures Valimail’s services are operational.
Endpoints
Validate Server Status
GET /healthcheck→ Confirms server availability (200 OK)
Authenticate API Credentials
POST /auth→ Generates a bearer token for secure requests
Example Request:
{
"client-id": "YOUR_CLIENT_ID",
"app-id": "YOUR_APP_ID"
}
Example Response:
{
"token": "YOUR_TOKEN",
"expires_at": "2023-05-10T08:00:00Z"
}
Usage:
Include the token in the Authorization header:
{
"Authorization": "Bearer YOUR_TOKEN"
}
Configure a Sandbox Domain
Using the DMARC Configuration API on a test domain allows you to:
Explore available endpoints
Test configuration changes before applying them to production
Ensure policy updates function as expected
Once the test setup is validated, proceed to load production domains through the API.
Need More Details?
Contact your account manager or product support to request the full API onboarding guide.