Documentation API Collano
Intégrez vos camions de collecte en quelques minutes
Démarrage rapide
1. Obtenez votre clé API
Contactez votre municipalité partenaire pour recevoir votre clé API sécurisée.
2. Testez l'endpoint
Envoyez votre premier événement de collecte avec une simple requête HTTP.
3. Intégrez dans vos systèmes
Utilisez notre API depuis vos camions ou systèmes de gestion de flotte.
Authentification
Toutes les requêtes API nécessitent une clé API valide envoyée dans le header HTTP.
Format de la clé:
collano_live_<32 caractères hexadécimaux>
Exemple de requête authentifiée:
X-API-Key: collano_live_a1b2c3d4e5f6...
Endpoint principal
/api/collector/events
Soumettre un événement de collecte
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
eventType |
string | Type d'anomalie: 'absent', 'malpositioned', 'wrong_bin', 'overfilled', 'damaged' | |
eventDate |
string | Date et heure de l'événement (format ISO 8601) | |
collectorName |
string | Nom ou identifiant du camion/collecteur | |
rfidTag |
string | Identifiant RFID du bac (ex: RFID123456789) | |
notes |
string | Notes additionnelles (optionnel) |
Types d'événements
absent Bac absent
Le bac n'était pas présent au moment de la collecte
malpositioned Bac mal positionné
Le bac n'était pas correctement positionné pour la collecte
wrong_bin Mauvais bac
Le bac ne correspond pas au type de collecte
overfilled Bac trop rempli
Le bac est débordant ou trop rempli
damaged Bac endommagé
Le bac est physiquement endommagé
Réponses
Succès - Événement créé
{
"success": true,
"eventId": "evt_abc123",
"message": "Collection event recorded successfully"
}
Erreur - Données invalides
{
"error": "Invalid data",
"details": [
{ "message": "eventType is required" }
]
}
Erreur - Clé API invalide
{
"error": "Invalid API key",
"message": "The provided API key is not valid"
}
Exemples de code
Support technique
Besoin d'aide? Notre équipe est là pour vous accompagner.
support@collano.ca
|1-800-555-COLLANO