Documentation API Novadesko

Authentification

Toutes les requêtes à l'API nécessitent un jeton dans l'en-tête HTTP.

// Header
Authorization: Bearer {token}

Pour obtenir un token :

POST /api/sanctum/token

// cURL
curl -X POST https://api.novadesko.com/api/sanctum/token \
  -H "Content-Type: application/json" \
  -d '{"email":"john@doe.com","password":"secret"}'

Requête

{
  "email": "john@doe.com",
  "password": "secret"
}

Réponse

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOi..."
}

Documents

Gérez tous types de documents : factures, devis, avoirs, etc.

GET/api/v1/documents/{slug}Lister les documents

POST/api/v1/documents/{slug}Créer un document

GET/api/v1/documents/{slug}/{id}Détail d'un document

PUT/api/v1/documents/{slug}/{id}Modifier

DELETE/api/v1/documents/{slug}/{id}Supprimer

Exemple : Factures

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/v1/documents/invoices

Réponse (extrait)

[
  {
    "id": 123,
    "number": "FAC-2026-0042",
    "date": "2024-06-12",
    "client": { "id": 1, "name": "ACME Sarl" },
    "total": 1200.00,
    "status": "paid"
  }
]

Création (POST)

{
  "client_id": 1,
  "date": "2024-06-12",
  "lines": [
    { "product_id": 15, "qty": 2, "price": 100 }
  ]
}

Clients

Gérez votre base de clients.

GET/api/v1/customers

POST/api/v1/customers

GET/api/v1/customers/{id}

PUT/api/v1/customers/{id}

DELETE/api/v1/customers/{id}

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/customers

Création (POST)

{
  "name": "Société Demo",
  "email": "contact@demo.com",
  "phone": "+33 1 23 45 67 89"
}

Réponse

{
  "id": 2,
  "name": "Société Demo",
  "email": "contact@demo.com",
  "created_at": "2024-06-12T16:10:00Z"
}

Fournisseurs

Gérez vos fournisseurs et leurs informations.

GET/api/suppliers

POST/api/suppliers

GET/api/suppliers/{id}

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/suppliers

Création (POST)

{
  "company": "Fournisseur SARL",
  "vat_number": "FR123456789",
  "email": "info@fournisseur.com"
}

Réponse

{
  "id": 5,
  "company": "Fournisseur SARL",
  "created_at": "2024-06-12T16:22:00Z"
}

Produits

Gérez votre catalogue de produits.

GET/api/products

POST/api/products

GET/api/products/{id}

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/products

Création (POST)

{
  "name": "Abonnement Pro",
  "price": 49.99,
  "category_id": 1
}

Réponse

{
  "id": 42,
  "name": "Abonnement Pro",
  "price": 49.99
}

Catégories Produits

Organisez vos produits par catégories.

GET/api/product-categories

POST/api/product-categories

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/product-categories

Création (POST)

{
  "name": "Services",
  "parent_id": null
}

Réponse

{
  "id": 7,
  "name": "Services"
}

Transactions

Suivez les flux financiers liés à vos documents.

GET/api/transactions

POST/api/transactions

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/transactions

Création (POST)

{
  "document_id": 123,
  "amount": 1200.00,
  "date": "2024-06-12",
  "type": "payment"
}

Réponse

{
  "id": 88,
  "document_id": 123,
  "amount": 1200.00,
  "type": "payment",
  "created_at": "2024-06-12T17:00:00Z"
}

Webhooks

Recevez des notifications en temps réel lors d'événements clés.

POST /webhook Recevoir les notifications

{
  "event": "invoice.paid",
  "data": {
    "id": 123,
    "number": "FAC-2026-0042",
    "amount": 1200.00,
    "client": { "id": 1, "name": "ACME Sarl" }
  }
}

Boutique

Gérez les paramètres de votre boutique : informations, adresse, coordonnées, options de facturation et plus encore.

GET/api/shop/showDétails de la boutique

POST/api/shop/updateModifier la boutique

GET/api/shop/optionsOptions (pays, langues, devises...)

PATCH/api/shop/settings/fieldModifier un champ (auto-save)

Exemple : Récupérer la boutique

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/shop/show

Réponse

{
  "id": 1,
  "name": "Ma Boutique",
  "company": "Demo SPRL",
  "company_identification": "BE0123456789",
  "email": "info@demo.com",
  "address": "Rue de la Loi 1",
  "city": "Bruxelles",
  "postcode": "1000",
  "country": { "id": 21, "name": "Belgique" },
  "category": { "id": 3, "name": "Commerce" },
  "bank_accounts": [...]
}

Modification

// POST /api/shop/update
{
  "name": "Ma Boutique",
  "email": "new@demo.com",
  "phone": "+32 2 123 45 67",
  "address": "Rue Neuve 10",
  "city": "Bruxelles",
  "postcode": "1000"
}

// PATCH /api/shop/settings/field
{
  "field": "website_enabled",
  "value": true
}

Horaires d'ouverture

Définissez les horaires d'ouverture par jour et les jours spéciaux (fermetures, congés).

POST/api/shop/settings/hoursMettre à jour les horaires

POST/api/shop/settings/special-daysJours spéciaux

// POST /api/shop/settings/hours
{
  "hours": [
    {
      "day": "monday",
      "is_open": true,
      "ranges": [
        { "open": "09:00", "close": "12:00" },
        { "open": "13:00", "close": "18:00" }
      ]
    },
    {
      "day": "sunday",
      "is_open": false,
      "ranges": []
    }
  ]
}

Comptes bancaires

Gérez les comptes bancaires liés à votre boutique (IBAN, BIC, banque par défaut).

GET/api/shop/bank-accountsLister les comptes

POST/api/shop/bank-accountsAjouter un compte

PUT/api/shop/bank-accounts/{id}Modifier

DELETE/api/shop/bank-accounts/{id}Supprimer

curl -H "Authorization: Bearer {token}" \
  https://api.novadesko.com/api/shop/bank-accounts

Création (POST)

{
  "bank_name": "BNP Paribas Fortis",
  "iban": "BE68 5390 0754 7034",
  "bic": "GEBABEBB",
  "is_default": true
}

Réponse

[
  {
    "id": 1,
    "bank_name": "BNP Paribas Fortis",
    "iban": "BE68 5390 0754 7034",
    "bic": "GEBABEBB",
    "is_default": true
  }
]

Réseaux sociaux

Gérez les liens vers les réseaux sociaux de votre boutique (Facebook, Instagram, LinkedIn...).

GET/api/shop/settings/social-mediaLister les réseaux

GET/api/shop/settings/social-media/availableRéseaux disponibles

POST/api/shop/settings/social-mediaAjouter un réseau

PUT/api/shop/settings/social-media/{id}Modifier l'URL

DELETE/api/shop/settings/social-media/{id}Supprimer

Création (POST)

{
  "social_media_id": 1,
  "url": "https://facebook.com/maboutique"
}

Réponse

[
  {
    "id": 1,
    "name": "Facebook",
    "icon": "ri-facebook-fill",
    "url": "https://facebook.com/maboutique"
  },
  {
    "id": 2,
    "name": "Instagram",
    "icon": "ri-instagram-line",
    "url": "https://instagram.com/maboutique"
  }
]

Menu

L'API Novadesko

Authentification

Documents

Clients

Fournisseurs

Produits

Catégories Produits

Transactions

Webhooks

Boutique

Horaires d'ouverture

Comptes bancaires

Prêt à intégrer Novadesko ?

Respect de votre vie privée

Gestion des cookies

Support Novadesko

Bonjour !