Livrez vos eBills dès aujourd'hui grâce à notre puissante API.

L'API REST de Dibito permet une intégration complète dans votre système de comptabilité. Suivez ce tutoriel pour avoir un aperçu des possibilités.

Conditions préalables

    • Vous avez installé curl ou un outil similaire en local.
    • Vous avez vérifié avec succès votre organisation auprès de Dibito en tant qu'émetteur de factures.

Pour d'autres langages de programmation comme Python, Java, C#, Go, etc., vous trouverez des exemples de programmation dans la documentation API.

Générer une clé API

Dans votre compte Dibito, allez sur Dibito -> Clé API et cliquez sur "Générer une clé".

Générer une clé API

Donnez un nom à la clé et notez la clé générée. Celle-ci sera nécessaire pour toutes les requêtes API.

Vous pouvez à tout moment générer de nouvelles clés ou supprimer des clés existantes.

Créer un exemple de facture

Attention: ces factures test sont envoyées dans le portail eBill productif. Des frais de transaction s'appliquent. Utilisez vous-même ou une personne informée des tests comme destinataire de l'eBill.

Dans un premier temps, vous avez besoin d'un exemple de facture pour tester l'API. Vous pouvez générer une facture test adaptée pour n'importe quel destinataire d'eBill directement dans Dibito sous l'option de menu "Exemples". Chacune des trois variantes de documents fonctionne avec l'API :

Générer des exemples de calcul dans Dibito

Vous pouvez également créer une facture de votre choix à l'aide de notre générateur de factures QR. Pour ce faire, utilisez l'IBAN QR de votre compte, définissez un numéro de référence QR et un destinataire eBill valide.

Enregistrez la facture QR générée au format PDF chez vous.

Remarque : chaque numéro de référence ne peut être livré qu'une seule fois au portail eBill. Pour toute autre tentative, vous devez générer de nouvelles factures.

Livrer la facture sous forme d'eBill

Pour livrer une facture au format PDF dans le portail eBill, il suffit d'utiliser la commande curl suivante :

curl -i -X POST \
  'https://app.dibito.ch/api/v1/business-cases?processingMode=STAGE' \
  -H 'Content-Type: application/pdf' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'x-filename: qr-invoice.pdf' \
  --data-binary '@/path/to/your/qr-invoice.pdf'

Remarque : Pour curl, dans ce cas, le @ devant le chemin d'accès au fichier est important pour envoyer le fichier sous forme de données binaires.

En cas de succès, votre facture se trouve maintenant dans Dibito parmi les transactions mises à disposition.

Si vous souhaitez livrer la facture directement au portail eBill après validation par Dibito, modifiez le paramètre processingMode sur DELIVER:

curl -i -X POST \
  'https://app.dibito.ch/api/v1/business-cases?processingMode=DELIVER' \
  -H 'Content-Type: application/pdf' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'x-filename: qr-invoice.pdf' \
  --data-binary '@/path/to/your/qr-invoice.pdf'

Dans ce cas, il n'est plus nécessaire d'effectuer une démarche manuelle pour l'activation.

Ouvrir la documentation API business-cases...

Rechercher un destinataire de facture

Pour pouvoir envoyer une facture à un destinataire, il est nécessaire que ce dernier s'inscrive valablement dans le système. Vous pouvez vérifier une inscription avec une adresse e-mail de la manière suivante :

curl -i -X POST \
https://app.dibito.ch/api/v1/bill-recipients/search \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
  "items": [
    {
      "emailAddress": "hans.muster@example.org"
    }
  ]
}'

La réponse au format JSON :

{
  "items": [
    {
      "emailAddress": "hans.muster@example.org",
      "billRecipientSixId": "41234567890123456",
      "activeSubscription": true,
      "enterpriseIdentificationNumber": null,
      "submissionStatus": "ALLOWED"
    }
  ]
}

Explication : le destinataire a été trouvé et renvoyé avec toutes les informations disponibles (dans ce cas, son adresse e-mail et son ebillRecipientId fixe unique).

Le drapeau activeSubscription est vrai, c'est-à-dire qu'il existe déjà une inscription de ce destinataire auprès de votre émetteur de factures.

Le site submissionStatus est ALLOWED. Vous pouvez envoyer des eBills à ce destinataire. Ce statut peut également être activé sans connexion sur ALLOWED Le destinataire doit autoriser l'envoi général d'eBills et l'avoir paramétré dans son portail eBill.

Ouvrir la documentation API bill-recipients...

Autres possibilités

L'API Dibito dispose d'autres fonctions :

Vous avez d'autres questions ? Contactez-nous.