Getting started
Connectez Twilee directement à vos propres outils et workflows.
Avec une clé API, votre équipe peut intégrer toute la puissance de Twilee directement dans votre environnement technique — automatiser la génération de QR codes, capturer les données de scans en temps réel et intégrer un suivi intelligent dans vos produits, le tout avec seulement quelques lignes de code.
Aperçu
- Chaque équipe peut créer une seule clé API.
- L’API prend actuellement en charge uniquement des opérations en lecture seule (
GET
). - Tous les endpoints renvoient des données au format JSON.
- La pagination est disponible pour les collections.
URL de base
https://api.twilee.com
Authentification
Toutes les requêtes doivent inclure votre clé API comme jeton Bearer dans l’en-tête d’autorisation.
Exemple :
GET /qr_codes HTTP/1.1
Host: api.twilee.com
Authorization: Bearer YOUR_API_KEY
Accept: application/json
Endpoints disponibles
Ressource | Description | Méthodes |
---|---|---|
/qr_codes |
Lister tous les QR codes | GET |
/qr_codes/{id} |
Obtenir un QR code spécifique | GET |
/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 YOUR_API_KEY" -H "Accept: application/json"
Exemple d’intégration (JavaScript)
const response = await fetch('https://api.twilee.com/qr_codes', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Accept': 'application/json'
}
});
const data = await response.json();
console.log(data.member);
Gestion des erreurs
Code | Signification | Description |
---|---|---|
200 |
OK | Requête réussie |
401 |
Non autorisé | Clé API manquante ou invalide |
404 |
Non trouvé | La ressource demandée n’existe pas |
429 |
Trop de requêtes | Limite de taux dépassée |
500 |
Erreur serveur | Une erreur interne est survenue |
✅ Tout est prêt !
Utilisez votre clé API pour consulter les statistiques des QR codes, suivre les interactions et garder vos applications synchronisées avec votre tableau de bord Twilee.