API Twilee – Prise en main

Connectez Twilee directement à vos propres outils et flux de travail.

Avec une clé API ou un jeton OAuth2, votre équipe peut intégrer la puissance de Twilee dans votre stack technique : automatisez la génération de QR codes, capturez les données de scan en temps réel et connectez un suivi intelligent à vos produits, le tout en quelques lignes de code.

Vue d'ensemble

Chaque équipe peut créer une seule clé API.
Tous les endpoints renvoient des données aux formats JSON et JSON-LD.
La pagination est disponible pour les endpoints de collection.
Les QR codes prennent en charge les opérations CRUD (GET, POST, PUT, DELETE) ainsi que des actions spécialisées pour schema.org et le téléchargement.
Tous les appels API nécessitent une authentification via une clé API ou un jeton OAuth2.

URL de base

https://api.twilee.com

Authentification et en-têtes

Tous les endpoints exigent l'en-tête Authorization avec un jeton valide et acceptent l'en-tête Accept pour préciser le format de réponse. Deux méthodes d'authentification sont disponibles.

Clé API

Chaque équipe peut générer une clé API depuis Équipe > Clé API. Transmettez-la comme jeton Bearer :

-H "Authorization: Bearer sk_TEAM_ID_SECRET" \
-H "Accept: application/json"

Jeton OAuth2

Vous pouvez également vous authentifier avec un jeton OAuth2 obtenu via le flux d'autorisation OAuth2 standard (le même flux utilisé par les intégrations MCP). Transmettez le JWT comme jeton Bearer :

-H "Authorization: Bearer VOTRE_JETON_OAUTH2" \
-H "Accept: application/json"

Pour obtenir un jeton OAuth2, suivez le flux d'autorisation décrit dans la documentation MCP.

Format de réponse

Formats acceptés pour l'en-tête Accept :

application/json
application/ld+json

Endpoints disponibles

Ressource	Description	Méthodes
`/qr_codes`	Lister tous les QR codes	`GET`
`/qr_codes/{id}`	Récupérer un QR code spécifique	`GET`
`/qr_codes/{id}/schemaorg`	Récupérer le payload schema.org d'un QR code	`GET`
`/qr_codes`	Créer un nouveau QR code	`POST`
`/qr_codes/{id}`	Mettre à jour un QR code spécifique	`PUT`
`/qr_codes/{id}`	Supprimer un QR code spécifique	`DELETE`
`/qr_codes/{id}/download`	Télécharger l'image rendue d'un QR code	`POST`
`/qr_codes/{id}/scans`	Lister les scans d'un QR code	`GET`
`/qr_codes/{id}/page-views`	Lister les vues de page d'un QR code	`GET`

Exemple de requête

curl -X GET "https://api.twilee.com/qr_codes" \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Accept: application/json"

Codes de statut HTTP

Code	Signification	Description
`200`	OK	La requête a réussi.
`201`	Created	La ressource a été créée avec succès.
`204`	No Content	La ressource a été supprimée avec succès.
`400`	Bad Request	Paramètres invalides ou manquants.
`401`	Unauthorized	Clé API ou jeton OAuth2 manquant ou invalide.
`403`	Forbidden	Authentifié mais non autorisé à effectuer l'action demandée.
`404`	Not Found	La ressource demandée n'existe pas.
`409`	Conflict	La ressource existe déjà.
`429`	Too Many Requests	Limite de débit dépassée.
`500`	Server Error	Une erreur inattendue est survenue.

Prochaines étapes

Générez une clé API pour votre équipe.
Créez votre premier QR code avec l'endpoint POST /qr_codes.
Récupérez le QR code, téléchargez l'image rendue et suivez les scans.

✅ Vous êtes prêt·e ! Commencez à intégrer les capacités de QR codes Twilee dans vos applications dès aujourd'hui.