Aller au contenu

Confirmer l’inscription d’un invité (lien reçu par e-mail)

POST
/v1/registrations/confirm
curl --request POST \
--url https://api.vimine.network/v1/registrations/confirm \
--header 'Content-Type: application/json' \
--data '{ "token": "example" }'

Consomme le jeton porté par le lien de confirmation : avec un type gratuit, l’inscription est confirmée (la réponse porte le token du QR) ; avec un type payant, elle reste réservée pendant le délai de réservation de l’événement et la réponse porte payment_instructions. Idempotent en cas de rejeu.

Type de médiaapplication/json
object
token
obligatoire
string
Exemplegénéré
{
"token": "example"
}

L’inscription

Type de médiaapplication/json
object
id
string format : uuid
status
string
Valeurs autorisées : reserved confirmed cancelled refunded
event
object
id
string
slug
string
title
string
starts_at
string format : date-time
ends_at
string format : date-time
nullable
timezone
string
status
string
location
string
nullable
registration_type
object
uid
string
cod
string
name
string
amount
number
currency
string
quantity
integer
reserved_until
string format : date-time
nullable
checked_in_at
string format : date-time
nullable
cancelled_at
string format : date-time
nullable
cancel_reason
string
nullable
can_cancel
boolean
payment
object
status
string
amount
number
currency
string
method
string
paid_at
string format : date-time
payment_instructions

Comment payer la contribution, tant que l’inscription est réservée

string
nullable
note

Texte libre écrit par la personne. Non transmis (null) aux clients tiers quand l’association a déclaré traiter des catégories particulières de données

string
nullable
created_at
string format : date-time
token

Le contenu du QR de l’inscription (vmt_…), inscriptions confirmées seulement

string
nullable
Exemple
{
"status": "reserved"
}

Le lien est invalide ou a expiré (invalid_token)

Introuvable

Type de médiaapplication/problem+json
object
type
obligatoire
string format : uri
title
obligatoire
string
status
obligatoire
integer
detail
string
code
obligatoire
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Exemplegénéré
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

L’inscription n’est plus active ou l’événement a été annulé

Limite de débit atteinte

Type de médiaapplication/problem+json
object
type
obligatoire
string format : uri
title
obligatoire
string
status
obligatoire
integer
detail
string
code
obligatoire
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Exemplegénéré
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

Erreur interne

Type de médiaapplication/problem+json
object
type
obligatoire
string format : uri
title
obligatoire
string
status
obligatoire
integer
detail
string
code
obligatoire
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Exemplegénéré
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}