Documentation API Certilink
Authentification
Obtenir un token d'accès
Endpoint : POST /auth/token
Description : Récupère le token d'identification Certificall à ajouter dans vos requêtes.
Body :
{
"username": "string",
"password": "string"
}
Réponse :
{
"token": "string"
}
Codes de réponse :
200
: Response with access token401
: Unauthorized
Trames (Frames)
Récupérer les trames de votre entreprise
Endpoint : GET /frames
Description : Récupérer la trame à utiliser pour la création du certificat.
Headers : Authorization: Bearer <token>
Réponse :
[
{
"id": "number",
"name": "string",
"steps": [
{
"id": "number",
"title": "string",
"description": "string"
}
]
}
]
Certilinks (Magic Links)
Créer un certilink
Endpoint : POST /certilink/create
Description : Créer un magic link.
Headers : Authorization: Bearer <token>
Body :
{
"reportToken": "string",
"frameId": "number",
"maxUses": "number",
"expirationDate": "string (format: aaaa-mm-jjThh:mm:ss.sss+hhmm)",
"companyId": "number"
}
Réponse :
{
"url": "string"
}
Création en masse de certilinks
Endpoint : POST /certilink/bulk-create
Description : Créer un magic link.
Headers : Authorization: Bearer <token>
Body : Array de MagicLinksCreateDto
[
{
"reportToken": "string",
"frameId": "number",
"maxUses": "number",
"expirationDate": "string (optionnel)",
"companyId": "number"
}
]
Réponse :
{
"url": "string"
}
Récupérer les certilinks d'une entreprise
Endpoint : POST /certilink/findCompanyMagicLinks
Description : Récupérer tous les magic links d'une company.
Headers : Authorization: Bearer <token>
Body :
{
"start": "number",
"limit": "number (maximum: 100)"
}
Réponse :
[
{
"reportToken": "string",
"url": "string",
"magicLinkToken": "string",
"createdAt": "Date",
"expirationDate": "Date",
"enabled": "boolean",
"frame": {
"id": "number",
"name": "string"
}
}
]
Supprimer un certilink
Endpoint : DELETE /certilink/{magicLinkToken}
Description : Supprimer un magic link.
Headers : Authorization: Bearer <token>