Consommateur
Un consommateur est un compte. Chaque clé est créée par un consommateur, et chaque appel que la clé effectue lui est attribué. Cette ressource lit ce compte et modifie les trois champs que l'API laisse changer. Il n'existe aucun appel permettant de créer ou de supprimer un consommateur.
Les appels
| Méthode | Chemin | Droit requis |
|---|---|---|
| GET | /v1/consumer | consumer:read |
| GET | /v1/consumer/<consumer_id> | consumer:read |
| PATCH | /v1/consumer | consumer:write |
<consumer_id> doit être votre propre compte, préfixé cons_. Nommer tout autre consommateur donne 403 et The API key doesn't have permissions to perform the request.
L'objet consommateur
| Champ | Type | Description |
|---|---|---|
id | chaîne | L'identifiant du consommateur, préfixé cons_. |
object | chaîne | Toujours consumer. |
name | chaîne | Le prénom. |
surname | chaîne | Le nom. |
country | chaîne | Le code pays. |
locale | chaîne | La langue de l'interface, sous forme de code ISO 639-3 à trois lettres. |
email | objet | L'adresse de courriel et sa vérification. Voir ci-dessous. |
phone | objet | Le numéro de téléphone et sa vérification. Voir ci-dessous. |
security | objet | L'état du mot de passe et de la double authentification. Voir ci-dessous. |
activity | objet | Les compteurs de connexion. Voir ci-dessous. |
status | chaîne | Le statut du compte. |
deleted_at | entier | Le moment où le compte a été supprimé, ou null. |
created_at | entier | Date de création, en secondes Unix. |
updated_at | entier | Dernière modification, en secondes Unix. |
| Objet | Champs |
|---|---|
email | address, is_verified, verified_at |
phone | number, e164, is_verified, verified_at |
security | password_renew, two_factor_enabled, password_updated_at |
activity | login_count, last_login_at |
Aucun mot de passe, aucune empreinte et aucun secret de double authentification n'est jamais renvoyé. security indique seulement si les protections sont actives et quand le mot de passe a changé pour la dernière fois.
Consulter le consommateur
curl https://api.think.ultineo.com/v1/consumer \
-H "Authorization: Bearer sk-project-YOUR_KEY"{
"code": 200,
"title": "OK",
"response": {
"id": "cons_8e2b45a10c9df7631b4a",
"object": "consumer",
"name": "Ada",
"surname": "Lovelace",
"country": "us",
"locale": "eng",
"email": {
"address": "ada@acme.example",
"is_verified": true,
"verified_at": 1751331600
},
"phone": {
"number": "+1 415 555 0132",
"e164": "+14155550132",
"is_verified": false,
"verified_at": null
},
"security": {
"password_renew": false,
"two_factor_enabled": true,
"password_updated_at": 1751328000
},
"activity": {
"login_count": 96,
"last_login_at": 1754204400
},
"status": "activated",
"deleted_at": null,
"created_at": 1751328000,
"updated_at": 1754204400
}
}Mettre à jour le consommateur
PATCH /v1/consumer accepte trois champs. N'envoyez que ce que vous souhaitez modifier.
| Paramètre | Type | Description |
|---|---|---|
name | chaîne | Un nouveau prénom. |
surname | chaîne | Un nouveau nom. |
locale | chaîne | Un code de langue ISO 639-3 à trois lettres, en minuscules. |
curl -X PATCH https://api.think.ultineo.com/v1/consumer \
-H "Authorization: Bearer sk-project-YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{ "locale": "fra" }'La réponse est l'objet consommateur complet, relu après la modification.
| Code | Message | Cause |
|---|---|---|
| 400 | No updatable field provided (name, surname, locale). | Le corps ne contenait aucun des trois champs. |
| 422 | locale must be a three-letter ISO-639-3 code. | Le code ne comportait pas trois lettres minuscules. |
Note — L'adresse de courriel, le numéro de téléphone, le mot de passe et les réglages de double authentification ne peuvent pas être modifiés par l'API, car chacun d'eux exige une étape de vérification. Modifiez-les depuis l'espace de travail.