API Documentatie

Introductie

De Imply API biedt programmatische toegang tot je email hosting service. Beheer domeinen, mailboxen, aliassen en monitor email verkeer.

Authenticatie

De API gebruikt JWT Bearer tokens. Voeg je token toe in de Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Rate Limiting

API verzoeken zijn gelimiteerd tot:

• 60 verzoeken per minuut voor geauthenticeerde gebruikers
• 20 verzoeken per minuut voor niet-geauthenticeerde verzoeken
• Burst allowance van 10 verzoeken

Authenticatie

Request Body

Response Voorbeeld

{
  "success": true,
  "message": "Login successful",
  "data": {
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "user": {
      "id": 123,
      "email": "user@example.com",
      "role": "user"
    }
  }
}

Domeinen

Query Parameters

Request Body

{
  "domain": "example.com",
  "catch_all": "admin@example.com"
}

Mailboxen

Request Body

{
  "email": "john@example.com",
  "password": "SecurePassword123!",
  "storage_quota_mb": 5120,
  "name": "John Doe"
}

Email Aliassen

Request Body

{
  "alias": "info@example.com",
  "destination": "john@example.com"
}

Webhooks

Ontvang real-time notificaties voor belangrijke events in je account.

Beschikbare Events

• domain.created - Nieuw domein aangemaakt
• domain.verified - Domein geverifieerd
• mailbox.created - Nieuwe mailbox aangemaakt
• mailbox.quota_exceeded - Mailbox quota overschreden
• email.received - Email ontvangen
• email.sent - Email verzonden

Webhook Payload Voorbeeld

{
  "event": "mailbox.created",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "mailbox_id": 456,
    "email": "john@example.com",
    "domain_id": 123
  }
}

Statistieken

Query Parameters

Error Responses

De API gebruikt standaard HTTP status codes en retourneert errors in JSON formaat.

HTTP Status Codes

Error Response Voorbeeld

{
  "success": false,
  "error": {
    "code": "INVALID_DOMAIN",
    "message": "The domain name is invalid or already exists",
    "details": {
      "field": "domain",
      "value": "invalid-domain"
    }
  }
}

Code Voorbeelden

cURL

curl -X POST https://imply.nl/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "password123"
  }'

JavaScript (Fetch)

const response = await fetch('https://imply.nl/api/v1/domains', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Python (Requests)

import requests

headers = {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.get('https://imply.nl/api/v1/domains', headers=headers)
data = response.json()
print(data)

PHP

$ch = curl_init('https://imply.nl/api/v1/domains');

curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_ACCESS_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);