Modèles de capture et langues
Choisissez les prises de vue et les textes que voit la personne, dans sa propre langue.
Qu'est-ce qu'un modèle
Un modèle de capture dit à la page de capture ce qu'elle doit demander : la liste des prises de vue (un nom et une consigne pour chacune, obligatoire ou non) et les textes d'accueil et de fin. Vous le créez une fois avec l'API et vous l'utilisez par son id (tpl_…). Le test et la production sont séparés : un modèle créé avec une clé de test n'existe pas en production, et inversement.
Créer un modèle
La réponse donne son id, tpl_… : c'est ainsi que vous désignez le modèle ensuite. Le nom n'est qu'un libellé pour le reconnaître dans une liste. Chaque texte peut être une simple chaîne, ou une chaîne par langue.
$ curl -X POST https://api.tryvidimus.com/v1/capture-templates \ -H "Authorization: Bearer $TRYVIDIMUS_API_KEY" \ -H "Content-Type: application/json" \ -d @template.json { "name": "pickup_car", "default_locale": "en", "welcome": { "title": { "en": "Welcome", "fr": "Bienvenue", "de": "Willkommen" } }, "steps": [ { "id": "front", "label": { "en": "Front", "fr": "Face avant", "de": "Vorderseite" }, "instruction": { "en": "Stand back", "fr": "Reculez", "de": "Gehen Sie zurück" } } ] }
L'utiliser dans une session de capture
Donnez son id dans template_id et la langue de la personne dans locale. Sans template_id, le modèle actif qui correspond à stage et category est utilisé, s'il y en a un ; un modèle sans stage ni category n'est utilisé que si vous le désignez.
$ curl -X POST https://api.tryvidimus.com/v1/capture-sessions \ -H "Authorization: Bearer $TRYVIDIMUS_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{"external_reference":"booking_4471","party":"provider","template_id":"tpl_01m4akapdbe8e8qq3er9r5qwyj","locale":"de"}'
Langues
Une langue est une étiquette BCP 47 : en, fr, es, de, mais aussi pt-BR, es-419 ou zh-Hans. Un texte donné comme une simple chaîne sert pour toutes les langues. Quand une langue manque, la page utilise la langue de base (pt pour pt-BR), puis la langue par défaut du modèle (default_locale), puis l'anglais. Un texte donné pour plusieurs langues doit contenir la langue par défaut, et un modèle compte 20 langues au plus.
Aspect de la page de capture : les styles
Un style est l'aspect de la page de capture : un nom, une couleur principale, une langue et un logo. Vous pouvez en avoir plusieurs, par exemple un par marque, et en choisir un par modèle avec theme_id. Votre premier style devient le style par défaut, utilisé par les modèles qui n'en désignent pas un autre. Les styles sont les mêmes en test et en production.
$ curl -X POST https://api.tryvidimus.com/v1/capture-themes \ -H "Authorization: Bearer $TRYVIDIMUS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"Gîte du Lac","primary_color":"#1f6b52","locale":"fr"}' { "id": "thm_01m4akapdbe8e8qq3er9r5qwyj", "name": "Gîte du Lac", "primary_color": "#1f6b52", "locale": "fr", "has_logo": false, "is_default": true }
Choisir un style dans un modèle
Donnez l'id d'un style (thm_…) comme theme_id quand vous créez ou modifiez un modèle, et null pour revenir à votre style par défaut. Un style utilisé par un modèle ne peut pas être archivé.
$ curl -X PATCH https://api.tryvidimus.com/v1/capture-templates/tpl_01m4akapdbe8e8qq3er9r5qwyj \ -H "Authorization: Bearer $TRYVIDIMUS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"theme_id":"thm_01m4akapdbe8e8qq3er9r5qwyj"}'
La page de capture elle-même
Les boutons et les messages de la page, qui ne sont pas vos textes, sont traduits par nous. La page de capture est en cours de construction : elle est prévue d'abord en anglais, français, espagnol et allemand, les autres langues suivront.
Modifier un modèle
Modifier un modèle ne change jamais un lien déjà envoyé : chaque session de capture garde sa propre copie. En production, un modèle à partir duquel des sessions ont été créées est figé, comme un prix une fois utilisé : pour le changer, dupliquez-le, modifiez la copie et utilisez l'id de la copie. Supprimer, c'est archiver : un modèle archivé ne démarre plus de session, et les preuves déjà faites le gardent. En mode test, les modèles restent modifiables.
$ curl -X POST https://api.tryvidimus.com/v1/capture-templates/tpl_01m4akapdbe8e8qq3er9r5qwyj/duplicate \ -H "Authorization: Bearer $TRYVIDIMUS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"pickup_car_v2"}' { "id": "tpl_01m4akapdc2nz8w9vbyx5qk3tq", "name": "pickup_car_v2", "stage": null, "category": null, "in_use": false, "archived_at": null }
Ces routes demandent une clé avec le droit manage_templates.