FactPulse SDK Ruby

Client Ruby officiel pour l'API FactPulse - Facturation électronique française.

🎯 Fonctionnalités

Factur-X : Génération et validation de factures électroniques (profils MINIMUM, BASIC, EN16931, EXTENDED)
Chorus Pro : Intégration avec la plateforme de facturation publique française
AFNOR PDP/PA : Soumission de flux conformes à la norme XP Z12-013
Signature électronique : Signature PDF (PAdES-B-B, PAdES-B-T, PAdES-B-LT)
Traitement asynchrone : Support Celery pour opérations longues
Ruby 2.7+ : Compatible avec les versions modernes de Ruby

🚀 Installation

gem install factpulse

Ou dans votre Gemfile :

gem 'factpulse'

📖 Démarrage rapide

1. Authentification

require 'factpulse'

# Configuration du client
FactPulse.configure do |config|
  config.host = 'https://factpulse.fr/api/facturation'
  config.access_token = 'votre_token_jwt'
end

api_instance = FactPulse::TraitementFactureApi.new

2. Générer une facture Factur-X

require 'json'

# Données de la facture
facture_data = {
  numero_facture: "FAC-2025-001",
  date_facture: "2025-01-15",
  montant_total_ht: "1000.00",
  montant_total_ttc: "1200.00",
  fournisseur: {
    nom: "Mon Entreprise SAS",
    siret: "12345678901234",
    adresse_postale: {
      ligne_un: "123 Rue Example",
      code_postal: "75001",
      nom_ville: "Paris",
      pays_code_iso: "FR"
    }
  },
  destinataire: {
    nom: "Client SARL",
    siret: "98765432109876",
    adresse_postale: {
      ligne_un: "456 Avenue Test",
      code_postal: "69001",
      nom_ville: "Lyon",
      pays_code_iso: "FR"
    }
  },
  lignes_de_poste: [{
    numero: 1,
    denomination: "Prestation de conseil",
    quantite: "10.00",
    montant_unitaire_ht: "100.00",
    montant_ligne_ht: "1000.00"
  }]
}

# Générer le PDF Factur-X
pdf_bytes = api_instance.generer_facture_api_v1_traitement_generer_facture_post(
  facture_data.to_json,
  'EN16931',
  'pdf'
)

# Sauvegarder
File.open('facture.pdf', 'wb') { |f| f.write(pdf_bytes) }

3. Soumettre une facture complète (Chorus Pro / AFNOR PDP)

response = api_instance.soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post({
  facture: facture_data,
  destination: {
    type: "chorus_pro",
    credentials: {
      login: "votre_login_chorus",
      password: "votre_password_chorus"
    }
  }
})

puts "Facture soumise : #{response.id_facture_chorus}"

🔑 Obtention du token JWT

Via l'API

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://factpulse.fr/api/token/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.path, {'Content-Type' => 'application/json'})
request.body = {
  username: '[email protected]',
  password: 'votre_mot_de_passe'
}.to_json

response = http.request(request)
result = JSON.parse(response.body)
token = result['access']

Accès aux credentials d'un client spécifique :

Si vous gérez plusieurs clients et souhaitez accéder aux credentials (Chorus Pro, AFNOR PDP) d'un client particulier, ajoutez le champ client_uid :

request.body = {
  username: '[email protected]',
  password: 'votre_mot_de_passe',
  client_uid: 'identifiant_client'  # UID du client cible
}.to_json