Référence de l’API
Routes
Les routes non listées ici sont réservées à l’application et répondent à une clé par 403 session_required. Les routes marquées idempotent acceptent un Idempotency-Key.
Codes
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/codes | codes:read | Lister les codes, filtrer par dossier, type ou statut |
| POST | /v1/codes | codes:write | Créer un codeidempotent |
| GET | /v1/codes/{id} | codes:read | Récupérer un code avec son design et ses règles |
| PATCH | /v1/codes/{id} | codes:write | Modifier la destination, le nom, le design, les règles |
| DELETE | /v1/codes/{id} | codes:write | Supprimer un code (son lien court répond 410) |
| POST | /v1/codes/move | codes:write | Déplacer des codes vers un dossieridempotent |
| POST | /v1/codes/move-domain | codes:write | Déplacer des codes vers un autre domaineidempotent |
| POST | /v1/codes/tags | codes:write | Ajouter ou retirer des étiquettes sur plusieurs codesidempotent |
| POST | /v1/codes/{id}/duplicate | codes:write | Dupliquer un codeidempotent |
| PATCH | /v1/codes/bulk | codes:write | Mettre en pause, reprendre, archiver, étiqueter, déplacer ou supprimer plusieurs codes |
| GET | /v1/utm-presets | codes:read | Lister les préréglages UTM enregistrés |
| GET | /v1/codes/{id}/versions | codes:read | Historique des destinations d’un code |
| GET | /v1/codes/{id}/activity | codes:read | Fil d’activité d’un code |
| GET | /v1/codes/{id}/export | codes:read | Télécharger en SVG, PNG, PDF ou EPS |
| GET | /v1/codes/{id}/hosted-stats | codes:read | Compteurs d’un code hébergé |
| GET | /v1/codes/{id}/submissions | submissions:read | Réponses à un code formulaire |
| GET | /v1/codes/{id}/submissions/export | submissions:read | Réponses du formulaire en CSV |
| GET | /v1/gs1/products | codes:read | Lister les produits GS1 (les codes gs1) |
| GET | /v1/codes/{id}/gs1/qualifiers | codes:read | Niveaux lot, CPV et numéro de série d’un code GS1 |
| GET | /v1/codes/{id}/gs1/print-runs | codes:read | Tirages d’impression d’un code GS1 |
| GET | /v1/codes/{id}/gs1/print-runs/{runId} | codes:read | Suivre un tirage d’impression et obtenir les liens de ses fichiers |
Séries en masse
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| POST | /v1/codes/bulk | codes:write | Créer jusqu’à 500 codes en une seule sérieidempotent |
| GET | /v1/bulk-imports | codes:read | Lister les séries en masse |
| GET | /v1/bulk-imports/{id} | codes:read | Interroger une série en masse |
| GET | /v1/bulk-imports/{id}/rows | codes:read | Lignes d’une série en masse |
| GET | /v1/bulk-imports/{id}/results.csv | codes:read | Résultats d’une série en CSV |
| POST | /v1/bulk-imports/{id}/cancel | codes:write | Annuler une série en file d’attente ou en coursidempotent |
| POST | /v1/bulk-imports/{id}/retry | codes:write | Réessayer les lignes échouées d’une sérieidempotent |
Statistiques
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/analytics/summary | analytics:read | Totaux de scans sur une période |
| GET | /v1/analytics/timeseries | analytics:read | Scans dans le temps |
| GET | /v1/analytics/breakdown | analytics:read | Principaux pays, appareils, … |
| GET | /v1/analytics/scans | analytics:read | Enregistrements par scan |
| GET | /v1/analytics/sparklines | analytics:read | Compteurs quotidiens des codes |
| GET | /v1/analytics/compare | analytics:read | Comparer jusqu’à 4 codes |
| GET | /v1/analytics/export | analytics:read | Scans en CSV (périodes courtes) |
| POST | /v1/analytics/exports | analytics:read | Scans en CSV, préparés en arrière-planidempotent |
| GET | /v1/codes/{id}/analytics/summary | analytics:read | Totaux d’un code |
| GET | /v1/codes/{id}/analytics/timeseries | analytics:read | Un code dans le temps |
| GET | /v1/codes/{id}/analytics/breakdown | analytics:read | Principaux classements d’un code |
| GET | /v1/codes/{id}/scans | analytics:read | Enregistrements par scan d’un code |
| GET | /v1/codes/{id}/gs1/batches | analytics:read | Scans par lot d’un code GS1 |
| GET | /v1/codes/{id}/downloads | analytics:read | Téléchargements par fichier d’un code Documents |
| GET | /v1/analytics/locations | analytics:read | Carte GPS des scans avec consentement |
| GET | /v1/codes/{id}/analytics/locations | analytics:read | La carte GPS d’un code |
| GET | /v1/alerts | analytics:read | Lister les règles d’alerte de scans |
Exports
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| POST | /v1/exports | codes:read | Exporter plusieurs codes dans un seul ZIPidempotent |
| GET | /v1/exports | codes:read | Lister les exports |
| GET | /v1/exports/{id} | codes:read | Interroger un export et obtenir le lien du ZIP |
Dossiers
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/folders | folders:read | Lister les dossiers |
| POST | /v1/folders | folders:write | Créer un dossieridempotent |
| GET | /v1/folders/{id} | folders:read | Récupérer un dossier |
| PATCH | /v1/folders/{id} | folders:write | Renommer ou déplacer un dossier |
| DELETE | /v1/folders/{id} | folders:write | Supprimer un dossier (les codes remontent) |
Modèles
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/templates | templates:read | Lister les modèles de design |
| POST | /v1/templates | templates:write | Créer un modèleidempotent |
| GET | /v1/templates/{id} | templates:read | Récupérer un modèle |
| PATCH | /v1/templates/{id} | templates:write | Modifier un modèle |
| DELETE | /v1/templates/{id} | templates:write | Supprimer un modèle |
Envois de fichiers
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| POST | /v1/assets | codes:write | Envoyer un logo ou un fichier |
| GET | /v1/assets/{id} | codes:read | Récupérer un fichier envoyé avec une URL signée |
Domaines
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/domains | domains:read | Lister les domaines personnalisés |
| GET | /v1/domains/{id} | domains:read | Récupérer un domaine et son statut |
| GET | /v1/subdomain | domains:read | Le sous-domaine de l’espace de travail et ses liens |
| GET | /v1/subdomain/availability | domains:read | Vérifier si un nom de sous-domaine est libre |
Espace de travail
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/workspaces/current | n’importe quelle clé | L’espace de travail de la clé et son offre |
| GET | /v1/usage | n’importe quelle clé | Limites de l’offre et utilisation ce mois-ci |
Webhooks
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/webhooks | webhooks:read | Lister les endpoints de webhooks |
| POST | /v1/webhooks | webhooks:write | Enregistrer un endpoint et ses types d’événementsidempotent |
| GET | /v1/webhooks/{id} | webhooks:read | Récupérer un endpoint |
| PATCH | /v1/webhooks/{id} | webhooks:write | Modifier ou réactiver un endpoint |
| DELETE | /v1/webhooks/{id} | webhooks:write | Supprimer un endpoint |
| POST | /v1/webhooks/{id}/test | webhooks:write | Envoyer un événement webhook.testidempotent |
| GET | /v1/webhooks/{id}/deliveries | webhooks:read | Envois d’un endpoint |
| GET | /v1/webhooks/{id}/deliveries/{deliveryId} | webhooks:read | Un envoi avec ses tentatives |
| POST | /v1/webhooks/{id}/deliveries/{deliveryId}/redeliver | webhooks:write | Renvoyer un envoiidempotent |
| POST | /v1/webhooks/{id}/recover | webhooks:write | Renvoyer les envois échouésidempotent |
Rapports
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| POST | /v1/reports | analytics:read | Générer un rapport statistique en PDF ou CSVidempotent |
| GET | /v1/reports | analytics:read | Lister les rapports générés |
| GET | /v1/reports/{id} | analytics:read | Consulter un rapport et obtenir son lien |
Hooks Zapier et Make
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/hooks | webhooks:read | Lister les hooks d’intégration |
| POST | /v1/hooks | webhooks:write | Abonner un hook à un événementidempotent |
| DELETE | /v1/hooks/{id} | webhooks:write | Désabonner un hook |
| GET | /v1/hooks/samples/{event} | webhooks:read | Événements récents d’un type, comme exemple pour un déclencheur |
Cartes de visite
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/cards | cards:read | Lister les cartes de visite de l’équipe |
| POST | /v1/cards | cards:write | Créer une carte de visiteidempotent |
| GET | /v1/cards/{id} | cards:read | Récupérer une carte de visite |
| PATCH | /v1/cards/{id} | cards:write | Modifier une carte de visite |
| POST | /v1/cards/{id}/deactivate | cards:write | Désactiver une carte de visiteidempotent |
| GET | /v1/cards/{id}/analytics | cards:read | Vues, enregistrements et clics d’une carte |
Conversions
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| POST | /v1/conversions | conversions:write | Enregistrer une conversionidempotent |
| GET | /v1/analytics/funnel | analytics:read | Entonnoir du scan au chiffre d’affaires |
Tags NFC
| Méthode | Chemin | Scope | Objet |
|---|---|---|---|
| GET | /v1/nfc/tags | codes:read | Lister les tags NFC |
| POST | /v1/nfc/tags | codes:write | Enregistrer un tag NFC sur un codeidempotent |