Récupérer une ECARD
Récupère les informations d'une carte de visite numérique existante.
GET /fiche/{slug}
Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
slug | string | Identifiant unique de l'ECARD (visible à la fin de son URL) |
Exemple de réponse
{
"slug": "xxxxxx",
"emailaccount": "john.doe@ecardnfc.fr",
"firstname": "John",
"lastname": "Doe",
"notes": "#dev, #ecard",
"company": "Developer ECARD",
"website": "https://ecardnfc.fr",
"phones": [
{
"label": "mobile",
"value": "+33612345678"
}
],
"emails": [
{
"label": "home",
"value": "john.doe@gmail.com"
}
],
"social_networks": [
{
"label": "Facebook",
"value": "https://facebook.com/johndoe"
},
{
"label": "Instagram",
"value": "https://instagram.com/jdoe"
}
],
"addresses": [
{
"label": "home",
"street": "Place du Capitole",
"extended": "",
"zipcode": "31000",
"city": "Toulouse",
"country": "fr"
}
],
"widgets": [
{
"label": "API Docs",
"type": "url",
"value": "https://ecardnfc.fr/mon-compte/api",
"redirect_id": "HQJatGxkO"
},
{
"label": "Documentation PDF",
"type": "file",
"value": "https://example.com/doc.pdf",
"redirect_id": "NSyXJ7SnQ"
}
]
}
Mettre à jour une ECARD
Met à jour les informations d'une carte de visite numérique existante.
PUT /fiche/{slug}
Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
slug | string | Identifiant unique de l'ECARD à modifier |
Comportement des champs
| Action | Résultat |
|---|---|
| Champ non fourni | Le champ conserve sa valeur actuelle |
| Champ fourni avec une valeur | Le champ est mis à jour avec la nouvelle valeur |
Champ fourni vide ("" ou []) | Le champ est vidé |
Note : Pour les tableaux (
phones,emails,social_networks,addresses,widgets), fournir de nouvelles valeurs remplace entièrement les valeurs existantes.
Corps de la requête
Champs principaux
{
"slug": "xxxxxx",
"emailaccount": "john.doe@ecardnfc.fr",
"firstname": "John",
"lastname": "Doe",
"notes": "#dev, #ecard",
"company": "Developer ECARD",
"website": "https://ecardnfc.fr",
"phones": [
{
"label": "mobile",
"value": "+33612345678"
}
],
"emails": [
{
"label": "home",
"value": "john.doe@gmail.com"
}
],
"social_networks": [
{
"label": "Facebook",
"value": "https://facebook.com/johndoe"
},
{
"label": "Instagram",
"value": "https://instagram.com/jdoe"
}
],
"addresses": [
{
"label": "home",
"street": "Place du Capitole",
"extended": "",
"zipcode": "31000",
"city": "Toulouse",
"country": "fr"
}
],
"widgets": [
{
"label": "API Docs",
"type": "url",
"value": "https://ecardnfc.fr/mon-compte/api",
"redirect_id": "HQJatGxkO"
},
{
"label": "Documentation PDF",
"type": "file",
"value": "https://example.com/doc.pdf",
"redirect_id": "NSyXJ7SnQ"
}
]
}
Téléphones (phones)
Tableau d'objets avec les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
label | string | Type de téléphone |
value | string | Numéro de téléphone |
Labels disponibles : mobile, home, work, school, main, home fax, work fax, pager, other
Emails (emails)
Tableau d'objets avec les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
label | string | Type d'email |
value | string (email) | Adresse email valide |
Labels disponibles : home, work, school, other
Réseaux sociaux (social_networks)
Tableau d'objets avec les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
label | string | Nom du réseau social |
value | string (URL) | URL du profil (doit inclure https://) |
Labels disponibles : Facebook, Twitter, Linkedin, Instagram, Snapchat, TikTok, Teams, Skype, Telegram, WhatsApp, Messenger, Twitch, YouTube, Pinterest, Vimeo
Adresses (addresses)
Tableau d'objets avec les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
label | string | Type d'adresse |
street | string | Rue et numéro |
extended | string | Complément d'adresse |
zipcode | string | Code postal |
city | string | Ville |
country | string | Code pays (ex: fr) |
Labels disponibles : home, work, school, other
Widgets (widgets)
Tableau d'objets avec les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
label | string | Libellé du widget |
type | string | Type de contenu : url ou file |
value | string (URL) | URL du lien ou du fichier (doit inclure https://) |
redirect_id | string | (Optionnel) Identifiant pour mettre à jour un widget existant sans modifier son URL de redirection |
Exemple de requête cURL
curl -X PUT "https://api.ecardnfc.fr/v1/fiche/xxxxxx" \
-u "API_KEY:API_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"firstname": "John",
"lastname": "Doe",
"company": "Developer ECARD",
"phones": [
{
"label": "mobile",
"value": "+33612345678"
},
{
"label": "work",
"value": "+33512345678"
}
]
}'