Endpoints principaux

Tous les endpoints sont préfixés par /api/v1.

Format des réponses

Ressource unique

{
    "data": {
        "id": 1,
        "name": "...",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Collection paginée

{
    "data": [...],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "per_page": 15,
        "to": 15,
        "total": 72
    },
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": "..."
    }
}

Sites

Méthode	Endpoint	Description
GET	/sites	Liste des sites
GET	/sites/{id}	Détail d’un site
POST	/sites	Créer un site
PATCH	/sites/{id}	Modifier un site
DELETE	/sites/{id}	Supprimer un site

Zones

Méthode	Endpoint	Description
GET	/zones	Liste des zones
GET	/zones/{id}	Détail d’une zone
POST	/zones	Créer une zone
PATCH	/zones/{id}	Modifier une zone
DELETE	/zones/{id}	Supprimer une zone

Tip

Utilisez ?include=children pour obtenir les zones enfants.

Matériels

Méthode	Endpoint	Description
GET	/materials	Liste des matériels
GET	/materials/{id}	Détail d’un matériel
POST	/materials	Créer un matériel
PATCH	/materials/{id}	Modifier un matériel
DELETE	/materials/{id}	Supprimer un matériel

Filtres disponibles

GET /materials?zone_id=5&status=active&search=compresseur

Maintenances

Méthode	Endpoint	Description
GET	/maintenances	Liste des maintenances
GET	/maintenances/{id}	Détail d’une maintenance
POST	/maintenances	Créer une maintenance
PATCH	/maintenances/{id}	Modifier une maintenance
DELETE	/maintenances/{id}	Supprimer une maintenance

Filtres

GET /maintenances?material_id=5&status=scheduled&type=preventive

Incidents

Méthode	Endpoint	Description
GET	/incidents	Liste des incidents
GET	/incidents/{id}	Détail d’un incident
POST	/incidents	Signaler un incident
PATCH	/incidents/{id}	Modifier un incident
DELETE	/incidents/{id}	Supprimer un incident

Nettoyages

Méthode	Endpoint	Description
GET	/cleanings	Liste des nettoyages
GET	/cleanings/{id}	Détail d’un nettoyage
POST	/cleanings	Créer un nettoyage
PATCH	/cleanings/{id}	Modifier un nettoyage
DELETE	/cleanings/{id}	Supprimer un nettoyage

Inventaire (Items)

Méthode	Endpoint	Description
GET	/items	Liste des pièces
GET	/items/{id}	Détail d’une pièce
POST	/items	Créer une pièce
PATCH	/items/{id}	Modifier une pièce
DELETE	/items/{id}	Supprimer une pièce

Mouvements de stock

Méthode	Endpoint	Description
GET	/item-movements	Liste des mouvements
GET	/item-movements/{id}	Détail d’un mouvement
POST	/item-movements	Créer un mouvement

Entreprises (HQ uniquement)

Méthode	Endpoint	Description
GET	/companies	Liste des entreprises
GET	/companies/{id}	Détail d’une entreprise
POST	/companies	Créer une entreprise
PATCH	/companies/{id}	Modifier une entreprise
DELETE	/companies/{id}	Supprimer une entreprise

Note

Les actions Create, Update & Delete pour les entreprises ne sont accessibles que depuis le Site Siège.

Utilisateurs

Méthode	Endpoint	Description
GET	/users	Liste des utilisateurs
GET	/users/{id}	Détail d’un utilisateur
POST	/users	Créer un utilisateur
PATCH	/users/{id}	Modifier un utilisateur
DELETE	/users/{id}	Supprimer un utilisateur

Rôles

Méthode	Endpoint	Description
GET	/roles	Liste des rôles
GET	/roles/{id}	Détail d’un rôle
POST	/roles	Créer un rôle
PATCH	/roles/{id}	Modifier un rôle
DELETE	/roles/{id}	Supprimer un rôle

Prochaines étapes

• Auth API - Endpoints d’authentification
• Déploiement Production - Mettre en ligne