Ga naar inhoud

API Aan de Slag

De AmiPhished REST API stelt u in staat om het platform te integreren met uw bestaande systemen.

  1. Ga naar Instellingen → API
  2. Klik Nieuwe API Key
  3. Geef een beschrijvende naam
  4. Selecteer permissies
  5. Kopieer de key (wordt maar 1x getoond)

Voeg de API key toe aan elke request:

Terminal window
curl https://api.amiphished.nl/v1/users \
-H "Authorization: Bearer YOUR_API_KEY"
https://api.amiphished.nl/v1

Voor development en testing:

https://api.sandbox.amiphished.nl/v1
PlanRequests/minuutRequests/dag
Starter6010.000
Professional300100.000
Enterprise1000Onbeperkt

Headers in response:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200

Alle responses zijn in JSON:

{
"success": true,
"data": {
// Response data
},
"meta": {
"page": 1,
"per_page": 25,
"total": 150
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Email is required",
"details": {
"field": "email",
"reason": "required"
}
}
}
MethodEndpointBeschrijving
GET/usersLijst alle gebruikers
POST/usersMaak nieuwe gebruiker
GET/users/{id}Haal gebruiker op
PUT/users/{id}Update gebruiker
DELETE/users/{id}Verwijder gebruiker
MethodEndpointBeschrijving
GET/campaignsLijst alle campagnes
POST/campaignsMaak nieuwe campagne
GET/campaigns/{id}Haal campagne op
POST/campaigns/{id}/startStart campagne
POST/campaigns/{id}/stopStop campagne
MethodEndpointBeschrijving
GET/reports/campaigns/{id}Campagne rapport
GET/reports/users/{id}Gebruiker rapport
GET/reports/complianceCompliance rapport
Terminal window
curl -X POST https://api.amiphished.nl/v1/users \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "jan@bedrijf.nl",
"first_name": "Jan",
"last_name": "Janssen",
"department": "IT",
"groups": ["all-users", "it-team"]
}'

Response:

{
"success": true,
"data": {
"id": "usr_123abc",
"email": "jan@bedrijf.nl",
"first_name": "Jan",
"last_name": "Janssen",
"department": "IT",
"created_at": "2025-01-15T10:30:00Z"
}
}
Terminal window
curl -X POST https://api.amiphished.nl/v1/campaigns/camp_456def/start \
-H "Authorization: Bearer YOUR_API_KEY"
Terminal window
curl https://api.amiphished.nl/v1/reports/campaigns/camp_456def \
-H "Authorization: Bearer YOUR_API_KEY"

Ontvang real-time notificaties:

  1. Ga naar Instellingen → API → Webhooks
  2. Voeg endpoint URL toe
  3. Selecteer events
  4. Sla op
  • campaign.started
  • campaign.completed
  • user.clicked
  • user.submitted
  • user.reported
  • training.completed
{
"event": "user.clicked",
"timestamp": "2025-01-15T10:30:00Z",
"data": {
"campaign_id": "camp_456def",
"user_id": "usr_123abc",
"template_id": "tmpl_789ghi"
}
}

Verifieer de signature:

X-AmiPhished-Signature: sha256=abc123...
Terminal window
pip install amiphished
from amiphished import Client
client = Client(api_key="YOUR_API_KEY")
users = client.users.list()
Terminal window
npm install @amiphished/sdk
const AmiPhished = require('@amiphished/sdk');
const client = new AmiPhished('YOUR_API_KEY');
const users = await client.users.list();