factpulse 1.0.8 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -3
- data/Gemfile.lock +1 -1
- data/docs/ChorusProApi.md +1 -1
- data/docs/MontantHtTotal1.md +15 -0
- data/docs/MontantTtcTotal1.md +15 -0
- data/docs/MontantTva1.md +15 -0
- data/docs/OptionsProcessing.md +1 -1
- data/docs/SoumettreFactureRequest.md +3 -3
- data/docs/StatutTache.md +1 -1
- data/lib/factpulse/models/montant_ht_total1.rb +104 -0
- data/lib/factpulse/models/montant_ttc_total1.rb +104 -0
- data/lib/factpulse/models/montant_tva1.rb +104 -0
- data/lib/factpulse/models/options_processing.rb +1 -15
- data/lib/factpulse/models/soumettre_facture_request.rb +3 -6
- data/lib/factpulse/models/statut_tache.rb +4 -2
- data/lib/factpulse/version.rb +1 -1
- data/lib/factpulse.rb +3 -2
- metadata +7 -5
- data/docs/ProcessingEndpointsUnifisApi.md +0 -147
- data/docs/SignatureLectroniqueApi.md +0 -315
- data/lib/factpulse/api/processing_endpoints_unifis_api.rb +0 -158
- data/lib/factpulse/api/signature_lectronique_api.rb +0 -333
|
@@ -1,147 +0,0 @@
|
|
|
1
|
-
# FactPulse::ProcessingEndpointsUnifisApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post**](ProcessingEndpointsUnifisApi.md#soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post) | **POST** /api/v1/traitement/factures/soumettre-complete | Soumettre une facture complète (génération + signature + soumission) |
|
|
8
|
-
| [**soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post**](ProcessingEndpointsUnifisApi.md#soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post) | **POST** /api/v1/traitement/factures/soumettre-complete-async | Soumettre une facture complète (asynchrone avec Celery) |
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post
|
|
12
|
-
|
|
13
|
-
> <SoumettreFactureCompleteResponse> soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post(soumettre_facture_complete_request)
|
|
14
|
-
|
|
15
|
-
Soumettre une facture complète (génération + signature + soumission)
|
|
16
|
-
|
|
17
|
-
Endpoint unifié pour soumettre une facture complète vers différentes destinations. **Workflow automatisé :** 1. **Auto-enrichissement** (optionnel) : récupère les données via APIs publiques et Chorus Pro/AFNOR 2. **Génération PDF Factur-X** : crée un PDF/A-3 avec XML embarqué 3. **Signature électronique** (optionnelle) : signe le PDF avec un certificat 4. **Soumission** : envoie vers la destination choisie (Chorus Pro ou AFNOR PDP) **Destinations supportées :** - **Chorus Pro** : plateforme B2G française (factures vers secteur public) - **AFNOR PDP** : Plateformes de Dématérialisation Partenaires **Credentials de destination - 2 modes disponibles :** **Mode 1 - Récupération via JWT (recommandé) :** - Les credentials sont récupérés automatiquement via le `client_uid` du JWT - Ne pas fournir le champ `credentials` dans `destination` - Architecture 0-trust : aucun secret dans le payload - Exemple : `\"destination\": {\"type\": \"chorus_pro\"}` **Mode 2 - Credentials dans le payload :** - Fournir les credentials directement dans le payload - Utile pour tests ou intégrations tierces - Exemple : `\"destination\": {\"type\": \"chorus_pro\", \"credentials\": {...}}` **Signature électronique (optionnelle) - 2 modes disponibles :** **Mode 1 - Certificat stocké (recommandé) :** - Le certificat est récupéré automatiquement via le `client_uid` du JWT - Aucune clé à fournir dans le payload - Signature PAdES-B-LT avec horodatage (conforme eIDAS) - Exemple : `\"signature\": {\"raison\": \"Conformité Factur-X\"}` **Mode 2 - Clés dans le payload (pour tests) :** - Fournir `key_pem` et `cert_pem` directement - Format PEM accepté : brut ou base64 - Utile pour tests ou cas spéciaux sans certificat stocké - Exemple : `\"signature\": {\"key_pem\": \"-----BEGIN...\", \"cert_pem\": \"-----BEGIN...\"}` Si `key_pem` et `cert_pem` sont fournis → Mode 2 Sinon → Mode 1 (certificat récupéré via `client_uid`)
|
|
18
|
-
|
|
19
|
-
### Examples
|
|
20
|
-
|
|
21
|
-
```ruby
|
|
22
|
-
require 'time'
|
|
23
|
-
require 'factpulse'
|
|
24
|
-
# setup authorization
|
|
25
|
-
FactPulse.configure do |config|
|
|
26
|
-
# Configure Bearer authorization: HTTPBearer
|
|
27
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
api_instance = FactPulse::ProcessingEndpointsUnifisApi.new
|
|
31
|
-
soumettre_facture_complete_request = FactPulse::SoumettreFactureCompleteRequest.new({donnees_facture: FactPulse::DonneesFactureSimplifiees.new({numero: 'numero_example', emetteur: { key: 3.56}, destinataire: { key: 3.56}, lignes: [{ key: 3.56}]}), pdf_source: 'pdf_source_example', destination: FactPulse::DestinationAFNOR.new}) # SoumettreFactureCompleteRequest |
|
|
32
|
-
|
|
33
|
-
begin
|
|
34
|
-
# Soumettre une facture complète (génération + signature + soumission)
|
|
35
|
-
result = api_instance.soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post(soumettre_facture_complete_request)
|
|
36
|
-
p result
|
|
37
|
-
rescue FactPulse::ApiError => e
|
|
38
|
-
puts "Error when calling ProcessingEndpointsUnifisApi->soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post: #{e}"
|
|
39
|
-
end
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
#### Using the soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post_with_http_info variant
|
|
43
|
-
|
|
44
|
-
This returns an Array which contains the response data, status code and headers.
|
|
45
|
-
|
|
46
|
-
> <Array(<SoumettreFactureCompleteResponse>, Integer, Hash)> soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post_with_http_info(soumettre_facture_complete_request)
|
|
47
|
-
|
|
48
|
-
```ruby
|
|
49
|
-
begin
|
|
50
|
-
# Soumettre une facture complète (génération + signature + soumission)
|
|
51
|
-
data, status_code, headers = api_instance.soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post_with_http_info(soumettre_facture_complete_request)
|
|
52
|
-
p status_code # => 2xx
|
|
53
|
-
p headers # => { ... }
|
|
54
|
-
p data # => <SoumettreFactureCompleteResponse>
|
|
55
|
-
rescue FactPulse::ApiError => e
|
|
56
|
-
puts "Error when calling ProcessingEndpointsUnifisApi->soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post_with_http_info: #{e}"
|
|
57
|
-
end
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Parameters
|
|
61
|
-
|
|
62
|
-
| Name | Type | Description | Notes |
|
|
63
|
-
| ---- | ---- | ----------- | ----- |
|
|
64
|
-
| **soumettre_facture_complete_request** | [**SoumettreFactureCompleteRequest**](SoumettreFactureCompleteRequest.md) | | |
|
|
65
|
-
|
|
66
|
-
### Return type
|
|
67
|
-
|
|
68
|
-
[**SoumettreFactureCompleteResponse**](SoumettreFactureCompleteResponse.md)
|
|
69
|
-
|
|
70
|
-
### Authorization
|
|
71
|
-
|
|
72
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
73
|
-
|
|
74
|
-
### HTTP request headers
|
|
75
|
-
|
|
76
|
-
- **Content-Type**: application/json
|
|
77
|
-
- **Accept**: application/json
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
## soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post
|
|
81
|
-
|
|
82
|
-
> <ReponseTache> soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post(soumettre_facture_complete_request)
|
|
83
|
-
|
|
84
|
-
Soumettre une facture complète (asynchrone avec Celery)
|
|
85
|
-
|
|
86
|
-
Version asynchrone de l'endpoint `/factures/soumettre-complete` utilisant Celery pour le traitement en arrière-plan. **Workflow automatisé (identique à la version synchrone) :** 1. **Auto-enrichissement** (optionnel) : récupère les données via APIs publiques et Chorus Pro/AFNOR 2. **Génération PDF Factur-X** : crée un PDF/A-3 avec XML embarqué 3. **Signature électronique** (optionnelle) : signe le PDF avec un certificat 4. **Soumission** : envoie vers la destination choisie (Chorus Pro ou AFNOR PDP) **Destinations supportées :** - **Chorus Pro** : plateforme B2G française (factures vers secteur public) - **AFNOR PDP** : Plateformes de Dématérialisation Partenaires **Différences avec la version synchrone :** - ✅ **Non-bloquant** : Retourne immédiatement un `id_tache` (HTTP 202 Accepted) - ✅ **Traitement en arrière-plan** : La facture est traitée par un worker Celery - ✅ **Suivi d'avancement** : Utilisez `/taches/{id_tache}/statut` pour suivre le statut - ✅ **Idéal pour gros volumes** : Permet de traiter de nombreuses factures en parallèle **Comment utiliser :** 1. **Soumission** : Appelez cet endpoint avec vos données de facture 2. **Retour immédiat** : Vous recevez un `id_tache` (ex: \"abc123-def456\") 3. **Suivi** : Appelez `/taches/{id_tache}/statut` pour vérifier l'avancement 4. **Résultat** : Quand `statut = \"SUCCESS\"`, le champ `resultat` contient la réponse complète **Credentials et signature** : Mêmes modes que la version synchrone (JWT ou payload).
|
|
87
|
-
|
|
88
|
-
### Examples
|
|
89
|
-
|
|
90
|
-
```ruby
|
|
91
|
-
require 'time'
|
|
92
|
-
require 'factpulse'
|
|
93
|
-
# setup authorization
|
|
94
|
-
FactPulse.configure do |config|
|
|
95
|
-
# Configure Bearer authorization: HTTPBearer
|
|
96
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
97
|
-
end
|
|
98
|
-
|
|
99
|
-
api_instance = FactPulse::ProcessingEndpointsUnifisApi.new
|
|
100
|
-
soumettre_facture_complete_request = FactPulse::SoumettreFactureCompleteRequest.new({donnees_facture: FactPulse::DonneesFactureSimplifiees.new({numero: 'numero_example', emetteur: { key: 3.56}, destinataire: { key: 3.56}, lignes: [{ key: 3.56}]}), pdf_source: 'pdf_source_example', destination: FactPulse::DestinationAFNOR.new}) # SoumettreFactureCompleteRequest |
|
|
101
|
-
|
|
102
|
-
begin
|
|
103
|
-
# Soumettre une facture complète (asynchrone avec Celery)
|
|
104
|
-
result = api_instance.soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post(soumettre_facture_complete_request)
|
|
105
|
-
p result
|
|
106
|
-
rescue FactPulse::ApiError => e
|
|
107
|
-
puts "Error when calling ProcessingEndpointsUnifisApi->soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post: #{e}"
|
|
108
|
-
end
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
#### Using the soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post_with_http_info variant
|
|
112
|
-
|
|
113
|
-
This returns an Array which contains the response data, status code and headers.
|
|
114
|
-
|
|
115
|
-
> <Array(<ReponseTache>, Integer, Hash)> soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post_with_http_info(soumettre_facture_complete_request)
|
|
116
|
-
|
|
117
|
-
```ruby
|
|
118
|
-
begin
|
|
119
|
-
# Soumettre une facture complète (asynchrone avec Celery)
|
|
120
|
-
data, status_code, headers = api_instance.soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post_with_http_info(soumettre_facture_complete_request)
|
|
121
|
-
p status_code # => 2xx
|
|
122
|
-
p headers # => { ... }
|
|
123
|
-
p data # => <ReponseTache>
|
|
124
|
-
rescue FactPulse::ApiError => e
|
|
125
|
-
puts "Error when calling ProcessingEndpointsUnifisApi->soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post_with_http_info: #{e}"
|
|
126
|
-
end
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### Parameters
|
|
130
|
-
|
|
131
|
-
| Name | Type | Description | Notes |
|
|
132
|
-
| ---- | ---- | ----------- | ----- |
|
|
133
|
-
| **soumettre_facture_complete_request** | [**SoumettreFactureCompleteRequest**](SoumettreFactureCompleteRequest.md) | | |
|
|
134
|
-
|
|
135
|
-
### Return type
|
|
136
|
-
|
|
137
|
-
[**ReponseTache**](ReponseTache.md)
|
|
138
|
-
|
|
139
|
-
### Authorization
|
|
140
|
-
|
|
141
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
142
|
-
|
|
143
|
-
### HTTP request headers
|
|
144
|
-
|
|
145
|
-
- **Content-Type**: application/json
|
|
146
|
-
- **Accept**: application/json
|
|
147
|
-
|
|
@@ -1,315 +0,0 @@
|
|
|
1
|
-
# FactPulse::SignatureLectroniqueApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**generer_certificat_test_api_v1_traitement_generer_certificat_test_post**](SignatureLectroniqueApi.md#generer_certificat_test_api_v1_traitement_generer_certificat_test_post) | **POST** /api/v1/traitement/generer-certificat-test | Générer un certificat X.509 auto-signé de test |
|
|
8
|
-
| [**signer_pdf_api_v1_traitement_signer_pdf_post**](SignatureLectroniqueApi.md#signer_pdf_api_v1_traitement_signer_pdf_post) | **POST** /api/v1/traitement/signer-pdf | Signer un PDF avec le certificat du client (PAdES-B-LT) |
|
|
9
|
-
| [**signer_pdf_async_api_v1_traitement_signer_pdf_async_post**](SignatureLectroniqueApi.md#signer_pdf_async_api_v1_traitement_signer_pdf_async_post) | **POST** /api/v1/traitement/signer-pdf-async | Signer un PDF de manière asynchrone (Celery) |
|
|
10
|
-
| [**valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post**](SignatureLectroniqueApi.md#valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post) | **POST** /api/v1/traitement/valider-signature-pdf | Valider les signatures électroniques d'un PDF |
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## generer_certificat_test_api_v1_traitement_generer_certificat_test_post
|
|
14
|
-
|
|
15
|
-
> <GenerateCertificateResponse> generer_certificat_test_api_v1_traitement_generer_certificat_test_post(generate_certificate_request)
|
|
16
|
-
|
|
17
|
-
Générer un certificat X.509 auto-signé de test
|
|
18
|
-
|
|
19
|
-
Génère un certificat X.509 auto-signé pour les tests de signature électronique PDF. **⚠️ ATTENTION : Certificat de TEST uniquement !** Ce certificat est : - ✅ Adapté pour tests et développement - ✅ Compatible signature PDF (PAdES) - ✅ Conforme eIDAS niveau **SES** (Simple Electronic Signature) - ❌ **JAMAIS utilisable en production** - ❌ **Non reconnu** par les navigateurs et lecteurs PDF - ❌ **Aucune valeur juridique** ## Niveaux eIDAS - **SES** (Simple) : Certificat auto-signé ← Généré par cet endpoint - **AdES** (Advanced) : Certificat CA commerciale (Let's Encrypt, etc.) - **QES** (Qualified) : Certificat qualifié PSCO (CertEurope, Universign, etc.) ## Utilisation Une fois généré, le certificat peut être : 1. **Enregistré dans Django** (recommandé) : - Django Admin > Certificats de signature - Upload `certificat_pem` et `cle_privee_pem` 2. **Utilisé directement** : - Signer un PDF avec `/signer-pdf` - Le certificat sera automatiquement utilisé ## Exemple d'appel ```bash curl -X POST \"https://www.factpulse.fr/api/facturation/generer-certificat-test\" \\ -H \"Authorization: Bearer eyJ0eXAi...\" \\ -H \"Content-Type: application/json\" \\ -d '{ \"cn\": \"Test Client XYZ\", \"organisation\": \"Client XYZ SARL\", \"email\": \"contact@xyz.fr\", \"duree_jours\": 365 }' ``` ## Cas d'usage - Tests de signature PDF en développement - POC de signature électronique - Formation et démos - Tests d'intégration automatisés ## Conformité technique Certificat généré avec : - Clé RSA 2048 ou 4096 bits - Algorithme SHA-256 - Extensions Key Usage : `digitalSignature`, `contentCommitment` (non-repudiation) - Extensions Extended Key Usage : `codeSigning`, `emailProtection` - Validité : 1 jour à 10 ans (configurable) - Format : PEM (certificat et clé) - Optionnel : PKCS#12 (.p12)
|
|
20
|
-
|
|
21
|
-
### Examples
|
|
22
|
-
|
|
23
|
-
```ruby
|
|
24
|
-
require 'time'
|
|
25
|
-
require 'factpulse'
|
|
26
|
-
# setup authorization
|
|
27
|
-
FactPulse.configure do |config|
|
|
28
|
-
# Configure Bearer authorization: HTTPBearer
|
|
29
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
33
|
-
generate_certificate_request = FactPulse::GenerateCertificateRequest.new # GenerateCertificateRequest |
|
|
34
|
-
|
|
35
|
-
begin
|
|
36
|
-
# Générer un certificat X.509 auto-signé de test
|
|
37
|
-
result = api_instance.generer_certificat_test_api_v1_traitement_generer_certificat_test_post(generate_certificate_request)
|
|
38
|
-
p result
|
|
39
|
-
rescue FactPulse::ApiError => e
|
|
40
|
-
puts "Error when calling SignatureLectroniqueApi->generer_certificat_test_api_v1_traitement_generer_certificat_test_post: #{e}"
|
|
41
|
-
end
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
#### Using the generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info variant
|
|
45
|
-
|
|
46
|
-
This returns an Array which contains the response data, status code and headers.
|
|
47
|
-
|
|
48
|
-
> <Array(<GenerateCertificateResponse>, Integer, Hash)> generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info(generate_certificate_request)
|
|
49
|
-
|
|
50
|
-
```ruby
|
|
51
|
-
begin
|
|
52
|
-
# Générer un certificat X.509 auto-signé de test
|
|
53
|
-
data, status_code, headers = api_instance.generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info(generate_certificate_request)
|
|
54
|
-
p status_code # => 2xx
|
|
55
|
-
p headers # => { ... }
|
|
56
|
-
p data # => <GenerateCertificateResponse>
|
|
57
|
-
rescue FactPulse::ApiError => e
|
|
58
|
-
puts "Error when calling SignatureLectroniqueApi->generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info: #{e}"
|
|
59
|
-
end
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### Parameters
|
|
63
|
-
|
|
64
|
-
| Name | Type | Description | Notes |
|
|
65
|
-
| ---- | ---- | ----------- | ----- |
|
|
66
|
-
| **generate_certificate_request** | [**GenerateCertificateRequest**](GenerateCertificateRequest.md) | | |
|
|
67
|
-
|
|
68
|
-
### Return type
|
|
69
|
-
|
|
70
|
-
[**GenerateCertificateResponse**](GenerateCertificateResponse.md)
|
|
71
|
-
|
|
72
|
-
### Authorization
|
|
73
|
-
|
|
74
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
75
|
-
|
|
76
|
-
### HTTP request headers
|
|
77
|
-
|
|
78
|
-
- **Content-Type**: application/json
|
|
79
|
-
- **Accept**: application/json
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
## signer_pdf_api_v1_traitement_signer_pdf_post
|
|
83
|
-
|
|
84
|
-
> Object signer_pdf_api_v1_traitement_signer_pdf_post(fichier_pdf, opts)
|
|
85
|
-
|
|
86
|
-
Signer un PDF avec le certificat du client (PAdES-B-LT)
|
|
87
|
-
|
|
88
|
-
Signe un PDF uploadé avec le certificat électronique configuré pour le client (via client_uid du JWT). **Standards supportés** : PAdES-B-B, PAdES-B-T (horodatage), PAdES-B-LT (archivage long terme). **Niveaux eIDAS** : SES (auto-signé), AdES (CA commerciale), QES (PSCO - hors scope). **⚠️ Disclaimer légal** : Les signatures générées sont des cachets électroniques au sens du règlement eIDAS. Le niveau de validité juridique dépend du certificat utilisé (SES/AdES/QES). FactPulse ne fournit pas de certificats qualifiés QES - vous devez obtenir un certificat auprès d'un PSCO (Prestataire de Services de Confiance qualifié) pour une validité juridique maximale.
|
|
89
|
-
|
|
90
|
-
### Examples
|
|
91
|
-
|
|
92
|
-
```ruby
|
|
93
|
-
require 'time'
|
|
94
|
-
require 'factpulse'
|
|
95
|
-
# setup authorization
|
|
96
|
-
FactPulse.configure do |config|
|
|
97
|
-
# Configure Bearer authorization: HTTPBearer
|
|
98
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
99
|
-
end
|
|
100
|
-
|
|
101
|
-
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
102
|
-
fichier_pdf = File.new('/path/to/some/file') # File | Fichier PDF à signer (sera traité puis retourné signé en base64)
|
|
103
|
-
opts = {
|
|
104
|
-
raison: 'raison_example', # String |
|
|
105
|
-
localisation: 'localisation_example', # String |
|
|
106
|
-
contact: 'contact_example', # String |
|
|
107
|
-
field_name: 'field_name_example', # String | Nom du champ de signature PDF
|
|
108
|
-
use_pades_lt: true, # Boolean | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL.
|
|
109
|
-
use_timestamp: true # Boolean | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T)
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
begin
|
|
113
|
-
# Signer un PDF avec le certificat du client (PAdES-B-LT)
|
|
114
|
-
result = api_instance.signer_pdf_api_v1_traitement_signer_pdf_post(fichier_pdf, opts)
|
|
115
|
-
p result
|
|
116
|
-
rescue FactPulse::ApiError => e
|
|
117
|
-
puts "Error when calling SignatureLectroniqueApi->signer_pdf_api_v1_traitement_signer_pdf_post: #{e}"
|
|
118
|
-
end
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
#### Using the signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info variant
|
|
122
|
-
|
|
123
|
-
This returns an Array which contains the response data, status code and headers.
|
|
124
|
-
|
|
125
|
-
> <Array(Object, Integer, Hash)> signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info(fichier_pdf, opts)
|
|
126
|
-
|
|
127
|
-
```ruby
|
|
128
|
-
begin
|
|
129
|
-
# Signer un PDF avec le certificat du client (PAdES-B-LT)
|
|
130
|
-
data, status_code, headers = api_instance.signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info(fichier_pdf, opts)
|
|
131
|
-
p status_code # => 2xx
|
|
132
|
-
p headers # => { ... }
|
|
133
|
-
p data # => Object
|
|
134
|
-
rescue FactPulse::ApiError => e
|
|
135
|
-
puts "Error when calling SignatureLectroniqueApi->signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info: #{e}"
|
|
136
|
-
end
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### Parameters
|
|
140
|
-
|
|
141
|
-
| Name | Type | Description | Notes |
|
|
142
|
-
| ---- | ---- | ----------- | ----- |
|
|
143
|
-
| **fichier_pdf** | **File** | Fichier PDF à signer (sera traité puis retourné signé en base64) | |
|
|
144
|
-
| **raison** | **String** | | [optional] |
|
|
145
|
-
| **localisation** | **String** | | [optional] |
|
|
146
|
-
| **contact** | **String** | | [optional] |
|
|
147
|
-
| **field_name** | **String** | Nom du champ de signature PDF | [optional][default to 'FactPulseSignature'] |
|
|
148
|
-
| **use_pades_lt** | **Boolean** | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL. | [optional][default to false] |
|
|
149
|
-
| **use_timestamp** | **Boolean** | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T) | [optional][default to true] |
|
|
150
|
-
|
|
151
|
-
### Return type
|
|
152
|
-
|
|
153
|
-
**Object**
|
|
154
|
-
|
|
155
|
-
### Authorization
|
|
156
|
-
|
|
157
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
158
|
-
|
|
159
|
-
### HTTP request headers
|
|
160
|
-
|
|
161
|
-
- **Content-Type**: multipart/form-data
|
|
162
|
-
- **Accept**: application/json
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
## signer_pdf_async_api_v1_traitement_signer_pdf_async_post
|
|
166
|
-
|
|
167
|
-
> Object signer_pdf_async_api_v1_traitement_signer_pdf_async_post(fichier_pdf, opts)
|
|
168
|
-
|
|
169
|
-
Signer un PDF de manière asynchrone (Celery)
|
|
170
|
-
|
|
171
|
-
Signe un PDF uploadé de manière asynchrone via une tâche Celery. **Différence avec /signer-pdf** : - `/signer-pdf` : Signature synchrone (blocage jusqu'à la fin) - `/signer-pdf-async` : Signature asynchrone (retourne immédiatement un task_id) **Avantages de l'async** : - Pas de timeout pour les gros fichiers - Pas de blocage du worker FastAPI - Possibilité de suivre la progression via le task_id - Idéal pour les traitements par lot **Standards supportés** : PAdES-B-B, PAdES-B-T (horodatage), PAdES-B-LT (archivage long terme). **⚠️ Disclaimer légal** : Identique à /signer-pdf (voir documentation de cet endpoint).
|
|
172
|
-
|
|
173
|
-
### Examples
|
|
174
|
-
|
|
175
|
-
```ruby
|
|
176
|
-
require 'time'
|
|
177
|
-
require 'factpulse'
|
|
178
|
-
# setup authorization
|
|
179
|
-
FactPulse.configure do |config|
|
|
180
|
-
# Configure Bearer authorization: HTTPBearer
|
|
181
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
182
|
-
end
|
|
183
|
-
|
|
184
|
-
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
185
|
-
fichier_pdf = File.new('/path/to/some/file') # File | Fichier PDF à signer (traité de manière asynchrone)
|
|
186
|
-
opts = {
|
|
187
|
-
raison: 'raison_example', # String |
|
|
188
|
-
localisation: 'localisation_example', # String |
|
|
189
|
-
contact: 'contact_example', # String |
|
|
190
|
-
field_name: 'field_name_example', # String | Nom du champ de signature PDF
|
|
191
|
-
use_pades_lt: true, # Boolean | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL.
|
|
192
|
-
use_timestamp: true # Boolean | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T)
|
|
193
|
-
}
|
|
194
|
-
|
|
195
|
-
begin
|
|
196
|
-
# Signer un PDF de manière asynchrone (Celery)
|
|
197
|
-
result = api_instance.signer_pdf_async_api_v1_traitement_signer_pdf_async_post(fichier_pdf, opts)
|
|
198
|
-
p result
|
|
199
|
-
rescue FactPulse::ApiError => e
|
|
200
|
-
puts "Error when calling SignatureLectroniqueApi->signer_pdf_async_api_v1_traitement_signer_pdf_async_post: #{e}"
|
|
201
|
-
end
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
#### Using the signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info variant
|
|
205
|
-
|
|
206
|
-
This returns an Array which contains the response data, status code and headers.
|
|
207
|
-
|
|
208
|
-
> <Array(Object, Integer, Hash)> signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info(fichier_pdf, opts)
|
|
209
|
-
|
|
210
|
-
```ruby
|
|
211
|
-
begin
|
|
212
|
-
# Signer un PDF de manière asynchrone (Celery)
|
|
213
|
-
data, status_code, headers = api_instance.signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info(fichier_pdf, opts)
|
|
214
|
-
p status_code # => 2xx
|
|
215
|
-
p headers # => { ... }
|
|
216
|
-
p data # => Object
|
|
217
|
-
rescue FactPulse::ApiError => e
|
|
218
|
-
puts "Error when calling SignatureLectroniqueApi->signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info: #{e}"
|
|
219
|
-
end
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
### Parameters
|
|
223
|
-
|
|
224
|
-
| Name | Type | Description | Notes |
|
|
225
|
-
| ---- | ---- | ----------- | ----- |
|
|
226
|
-
| **fichier_pdf** | **File** | Fichier PDF à signer (traité de manière asynchrone) | |
|
|
227
|
-
| **raison** | **String** | | [optional] |
|
|
228
|
-
| **localisation** | **String** | | [optional] |
|
|
229
|
-
| **contact** | **String** | | [optional] |
|
|
230
|
-
| **field_name** | **String** | Nom du champ de signature PDF | [optional][default to 'FactPulseSignature'] |
|
|
231
|
-
| **use_pades_lt** | **Boolean** | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL. | [optional][default to false] |
|
|
232
|
-
| **use_timestamp** | **Boolean** | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T) | [optional][default to true] |
|
|
233
|
-
|
|
234
|
-
### Return type
|
|
235
|
-
|
|
236
|
-
**Object**
|
|
237
|
-
|
|
238
|
-
### Authorization
|
|
239
|
-
|
|
240
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
241
|
-
|
|
242
|
-
### HTTP request headers
|
|
243
|
-
|
|
244
|
-
- **Content-Type**: multipart/form-data
|
|
245
|
-
- **Accept**: application/json
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
## valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post
|
|
249
|
-
|
|
250
|
-
> Object valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post(fichier_pdf)
|
|
251
|
-
|
|
252
|
-
Valider les signatures électroniques d'un PDF
|
|
253
|
-
|
|
254
|
-
Valide les signatures électroniques présentes dans un PDF uploadé. **Vérifications effectuées** : - Présence de signatures - Intégrité du document (non modifié depuis signature) - Validité des certificats - Chaîne de confiance (si disponible) - Présence d'horodatage (PAdES-B-T) - Données de validation (PAdES-B-LT) **Standards supportés** : PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2. **⚠️ Note** : Cette validation est technique (intégrité cryptographique). La validité juridique dépend du niveau eIDAS du certificat (SES/AdES/QES) et du contexte d'utilisation.
|
|
255
|
-
|
|
256
|
-
### Examples
|
|
257
|
-
|
|
258
|
-
```ruby
|
|
259
|
-
require 'time'
|
|
260
|
-
require 'factpulse'
|
|
261
|
-
# setup authorization
|
|
262
|
-
FactPulse.configure do |config|
|
|
263
|
-
# Configure Bearer authorization: HTTPBearer
|
|
264
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
265
|
-
end
|
|
266
|
-
|
|
267
|
-
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
268
|
-
fichier_pdf = File.new('/path/to/some/file') # File | Fichier PDF à valider (sera analysé pour détecter et valider les signatures)
|
|
269
|
-
|
|
270
|
-
begin
|
|
271
|
-
# Valider les signatures électroniques d'un PDF
|
|
272
|
-
result = api_instance.valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post(fichier_pdf)
|
|
273
|
-
p result
|
|
274
|
-
rescue FactPulse::ApiError => e
|
|
275
|
-
puts "Error when calling SignatureLectroniqueApi->valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post: #{e}"
|
|
276
|
-
end
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
#### Using the valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info variant
|
|
280
|
-
|
|
281
|
-
This returns an Array which contains the response data, status code and headers.
|
|
282
|
-
|
|
283
|
-
> <Array(Object, Integer, Hash)> valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info(fichier_pdf)
|
|
284
|
-
|
|
285
|
-
```ruby
|
|
286
|
-
begin
|
|
287
|
-
# Valider les signatures électroniques d'un PDF
|
|
288
|
-
data, status_code, headers = api_instance.valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info(fichier_pdf)
|
|
289
|
-
p status_code # => 2xx
|
|
290
|
-
p headers # => { ... }
|
|
291
|
-
p data # => Object
|
|
292
|
-
rescue FactPulse::ApiError => e
|
|
293
|
-
puts "Error when calling SignatureLectroniqueApi->valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info: #{e}"
|
|
294
|
-
end
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
### Parameters
|
|
298
|
-
|
|
299
|
-
| Name | Type | Description | Notes |
|
|
300
|
-
| ---- | ---- | ----------- | ----- |
|
|
301
|
-
| **fichier_pdf** | **File** | Fichier PDF à valider (sera analysé pour détecter et valider les signatures) | |
|
|
302
|
-
|
|
303
|
-
### Return type
|
|
304
|
-
|
|
305
|
-
**Object**
|
|
306
|
-
|
|
307
|
-
### Authorization
|
|
308
|
-
|
|
309
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
310
|
-
|
|
311
|
-
### HTTP request headers
|
|
312
|
-
|
|
313
|
-
- **Content-Type**: multipart/form-data
|
|
314
|
-
- **Accept**: application/json
|
|
315
|
-
|
|
@@ -1,158 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#API REST FactPulse
|
|
3
|
-
|
|
4
|
-
# API REST pour la facturation électronique en France : Factur-X, AFNOR PDP/PA, signatures électroniques. ## 🎯 Fonctionnalités principales ### 📄 Génération de factures Factur-X - **Formats** : XML seul ou PDF/A-3 avec XML embarqué - **Profils** : MINIMUM, BASIC, EN16931, EXTENDED - **Normes** : EN 16931 (directive UE 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Format simplifié** : Génération à partir de SIRET + auto-enrichissement (API Chorus Pro + Recherche Entreprises) ### ✅ Validation et conformité - **Validation XML** : Schematron (45 à 210+ règles selon profil) - **Validation PDF** : PDF/A-3, métadonnées XMP Factur-X, signatures électroniques - **VeraPDF** : Validation stricte PDF/A (146+ règles ISO 19005-3) - **Traitement asynchrone** : Support Celery pour validations lourdes (VeraPDF) ### 📡 Intégration AFNOR PDP/PA (XP Z12-013) - **Soumission de flux** : Envoi de factures vers Plateformes de Dématérialisation Partenaires - **Recherche de flux** : Consultation des factures soumises - **Téléchargement** : Récupération des PDF/A-3 avec XML - **Directory Service** : Recherche d'entreprises (SIREN/SIRET) - **Multi-client** : Support de plusieurs configs PDP par utilisateur (stored credentials ou zero-storage) ### ✍️ Signature électronique PDF - **Standards** : PAdES-B-B, PAdES-B-T (horodatage RFC 3161), PAdES-B-LT (archivage long terme) - **Niveaux eIDAS** : SES (auto-signé), AdES (CA commerciale), QES (PSCO) - **Validation** : Vérification intégrité cryptographique et certificats - **Génération de certificats** : Certificats X.509 auto-signés pour tests ### 🔄 Traitement asynchrone - **Celery** : Génération, validation et signature asynchrones - **Polling** : Suivi d'état via `/taches/{id_tache}/statut` - **Pas de timeout** : Idéal pour gros fichiers ou validations lourdes ## 🔒 Authentification Toutes les requêtes nécessitent un **token JWT** dans le header Authorization : ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### Comment obtenir un token JWT ? #### 🔑 Méthode 1 : API `/api/token/` (Recommandée) **URL :** `https://www.factpulse.fr/api/token/` Cette méthode est **recommandée** pour l'intégration dans vos applications et workflows CI/CD. **Prérequis :** Avoir défini un mot de passe sur votre compte **Pour les utilisateurs inscrits via email/password :** - Vous avez déjà un mot de passe, utilisez-le directement **Pour les utilisateurs inscrits via OAuth (Google/GitHub) :** - Vous devez d'abord définir un mot de passe sur : https://www.factpulse.fr/accounts/password/set/ - Une fois le mot de passe créé, vous pourrez utiliser l'API **Exemple de requête :** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"votre_email@example.com\", \"password\": \"votre_mot_de_passe\" }' ``` **Réponse :** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Token d'accès (validité: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Token de rafraîchissement (validité: 7 jours) } ``` **Avantages :** - ✅ Automatisation complète (CI/CD, scripts) - ✅ Gestion programmatique des tokens - ✅ Support du refresh token pour renouveler automatiquement l'accès - ✅ Intégration facile dans n'importe quel langage/outil #### 🖥️ Méthode 2 : Génération via Dashboard (Alternative) **URL :** https://www.factpulse.fr/dashboard/ Cette méthode convient pour des tests rapides ou une utilisation occasionnelle via l'interface graphique. **Fonctionnement :** - Connectez-vous au dashboard - Utilisez les boutons \"Generate Test Token\" ou \"Generate Production Token\" - Fonctionne pour **tous** les utilisateurs (OAuth et email/password), sans nécessiter de mot de passe **Types de tokens :** - **Token Test** : Validité 24h, quota 1000 appels/jour (gratuit) - **Token Production** : Validité 7 jours, quota selon votre forfait **Avantages :** - ✅ Rapide pour tester l'API - ✅ Aucun mot de passe requis - ✅ Interface visuelle simple **Inconvénients :** - ❌ Nécessite une action manuelle - ❌ Pas de refresh token - ❌ Moins adapté pour l'automatisation ### 📚 Documentation complète Pour plus d'informations sur l'authentification et l'utilisation de l'API : https://www.factpulse.fr/documentation-api/
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
|
7
|
-
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.18.0-SNAPSHOT
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'cgi'
|
|
14
|
-
|
|
15
|
-
module FactPulse
|
|
16
|
-
class ProcessingEndpointsUnifisApi
|
|
17
|
-
attr_accessor :api_client
|
|
18
|
-
|
|
19
|
-
def initialize(api_client = ApiClient.default)
|
|
20
|
-
@api_client = api_client
|
|
21
|
-
end
|
|
22
|
-
# Soumettre une facture complète (génération + signature + soumission)
|
|
23
|
-
# Endpoint unifié pour soumettre une facture complète vers différentes destinations. **Workflow automatisé :** 1. **Auto-enrichissement** (optionnel) : récupère les données via APIs publiques et Chorus Pro/AFNOR 2. **Génération PDF Factur-X** : crée un PDF/A-3 avec XML embarqué 3. **Signature électronique** (optionnelle) : signe le PDF avec un certificat 4. **Soumission** : envoie vers la destination choisie (Chorus Pro ou AFNOR PDP) **Destinations supportées :** - **Chorus Pro** : plateforme B2G française (factures vers secteur public) - **AFNOR PDP** : Plateformes de Dématérialisation Partenaires **Credentials de destination - 2 modes disponibles :** **Mode 1 - Récupération via JWT (recommandé) :** - Les credentials sont récupérés automatiquement via le `client_uid` du JWT - Ne pas fournir le champ `credentials` dans `destination` - Architecture 0-trust : aucun secret dans le payload - Exemple : `\"destination\": {\"type\": \"chorus_pro\"}` **Mode 2 - Credentials dans le payload :** - Fournir les credentials directement dans le payload - Utile pour tests ou intégrations tierces - Exemple : `\"destination\": {\"type\": \"chorus_pro\", \"credentials\": {...}}` **Signature électronique (optionnelle) - 2 modes disponibles :** **Mode 1 - Certificat stocké (recommandé) :** - Le certificat est récupéré automatiquement via le `client_uid` du JWT - Aucune clé à fournir dans le payload - Signature PAdES-B-LT avec horodatage (conforme eIDAS) - Exemple : `\"signature\": {\"raison\": \"Conformité Factur-X\"}` **Mode 2 - Clés dans le payload (pour tests) :** - Fournir `key_pem` et `cert_pem` directement - Format PEM accepté : brut ou base64 - Utile pour tests ou cas spéciaux sans certificat stocké - Exemple : `\"signature\": {\"key_pem\": \"-----BEGIN...\", \"cert_pem\": \"-----BEGIN...\"}` Si `key_pem` et `cert_pem` sont fournis → Mode 2 Sinon → Mode 1 (certificat récupéré via `client_uid`)
|
|
24
|
-
# @param soumettre_facture_complete_request [SoumettreFactureCompleteRequest]
|
|
25
|
-
# @param [Hash] opts the optional parameters
|
|
26
|
-
# @return [SoumettreFactureCompleteResponse]
|
|
27
|
-
def soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post(soumettre_facture_complete_request, opts = {})
|
|
28
|
-
data, _status_code, _headers = soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post_with_http_info(soumettre_facture_complete_request, opts)
|
|
29
|
-
data
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
# Soumettre une facture complète (génération + signature + soumission)
|
|
33
|
-
# Endpoint unifié pour soumettre une facture complète vers différentes destinations. **Workflow automatisé :** 1. **Auto-enrichissement** (optionnel) : récupère les données via APIs publiques et Chorus Pro/AFNOR 2. **Génération PDF Factur-X** : crée un PDF/A-3 avec XML embarqué 3. **Signature électronique** (optionnelle) : signe le PDF avec un certificat 4. **Soumission** : envoie vers la destination choisie (Chorus Pro ou AFNOR PDP) **Destinations supportées :** - **Chorus Pro** : plateforme B2G française (factures vers secteur public) - **AFNOR PDP** : Plateformes de Dématérialisation Partenaires **Credentials de destination - 2 modes disponibles :** **Mode 1 - Récupération via JWT (recommandé) :** - Les credentials sont récupérés automatiquement via le `client_uid` du JWT - Ne pas fournir le champ `credentials` dans `destination` - Architecture 0-trust : aucun secret dans le payload - Exemple : `\"destination\": {\"type\": \"chorus_pro\"}` **Mode 2 - Credentials dans le payload :** - Fournir les credentials directement dans le payload - Utile pour tests ou intégrations tierces - Exemple : `\"destination\": {\"type\": \"chorus_pro\", \"credentials\": {...}}` **Signature électronique (optionnelle) - 2 modes disponibles :** **Mode 1 - Certificat stocké (recommandé) :** - Le certificat est récupéré automatiquement via le `client_uid` du JWT - Aucune clé à fournir dans le payload - Signature PAdES-B-LT avec horodatage (conforme eIDAS) - Exemple : `\"signature\": {\"raison\": \"Conformité Factur-X\"}` **Mode 2 - Clés dans le payload (pour tests) :** - Fournir `key_pem` et `cert_pem` directement - Format PEM accepté : brut ou base64 - Utile pour tests ou cas spéciaux sans certificat stocké - Exemple : `\"signature\": {\"key_pem\": \"-----BEGIN...\", \"cert_pem\": \"-----BEGIN...\"}` Si `key_pem` et `cert_pem` sont fournis → Mode 2 Sinon → Mode 1 (certificat récupéré via `client_uid`)
|
|
34
|
-
# @param soumettre_facture_complete_request [SoumettreFactureCompleteRequest]
|
|
35
|
-
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @return [Array<(SoumettreFactureCompleteResponse, Integer, Hash)>] SoumettreFactureCompleteResponse data, response status code and response headers
|
|
37
|
-
def soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post_with_http_info(soumettre_facture_complete_request, opts = {})
|
|
38
|
-
if @api_client.config.debugging
|
|
39
|
-
@api_client.config.logger.debug 'Calling API: ProcessingEndpointsUnifisApi.soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post ...'
|
|
40
|
-
end
|
|
41
|
-
# verify the required parameter 'soumettre_facture_complete_request' is set
|
|
42
|
-
if @api_client.config.client_side_validation && soumettre_facture_complete_request.nil?
|
|
43
|
-
fail ArgumentError, "Missing the required parameter 'soumettre_facture_complete_request' when calling ProcessingEndpointsUnifisApi.soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post"
|
|
44
|
-
end
|
|
45
|
-
# resource path
|
|
46
|
-
local_var_path = '/api/v1/traitement/factures/soumettre-complete'
|
|
47
|
-
|
|
48
|
-
# query parameters
|
|
49
|
-
query_params = opts[:query_params] || {}
|
|
50
|
-
|
|
51
|
-
# header parameters
|
|
52
|
-
header_params = opts[:header_params] || {}
|
|
53
|
-
# HTTP header 'Accept' (if needed)
|
|
54
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
|
-
# HTTP header 'Content-Type'
|
|
56
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
57
|
-
if !content_type.nil?
|
|
58
|
-
header_params['Content-Type'] = content_type
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
# form parameters
|
|
62
|
-
form_params = opts[:form_params] || {}
|
|
63
|
-
|
|
64
|
-
# http body (model)
|
|
65
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(soumettre_facture_complete_request)
|
|
66
|
-
|
|
67
|
-
# return_type
|
|
68
|
-
return_type = opts[:debug_return_type] || 'SoumettreFactureCompleteResponse'
|
|
69
|
-
|
|
70
|
-
# auth_names
|
|
71
|
-
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
72
|
-
|
|
73
|
-
new_options = opts.merge(
|
|
74
|
-
:operation => :"ProcessingEndpointsUnifisApi.soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post",
|
|
75
|
-
:header_params => header_params,
|
|
76
|
-
:query_params => query_params,
|
|
77
|
-
:form_params => form_params,
|
|
78
|
-
:body => post_body,
|
|
79
|
-
:auth_names => auth_names,
|
|
80
|
-
:return_type => return_type
|
|
81
|
-
)
|
|
82
|
-
|
|
83
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
84
|
-
if @api_client.config.debugging
|
|
85
|
-
@api_client.config.logger.debug "API called: ProcessingEndpointsUnifisApi#soumettre_facture_complete_api_v1_traitement_factures_soumettre_complete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
-
end
|
|
87
|
-
return data, status_code, headers
|
|
88
|
-
end
|
|
89
|
-
|
|
90
|
-
# Soumettre une facture complète (asynchrone avec Celery)
|
|
91
|
-
# Version asynchrone de l'endpoint `/factures/soumettre-complete` utilisant Celery pour le traitement en arrière-plan. **Workflow automatisé (identique à la version synchrone) :** 1. **Auto-enrichissement** (optionnel) : récupère les données via APIs publiques et Chorus Pro/AFNOR 2. **Génération PDF Factur-X** : crée un PDF/A-3 avec XML embarqué 3. **Signature électronique** (optionnelle) : signe le PDF avec un certificat 4. **Soumission** : envoie vers la destination choisie (Chorus Pro ou AFNOR PDP) **Destinations supportées :** - **Chorus Pro** : plateforme B2G française (factures vers secteur public) - **AFNOR PDP** : Plateformes de Dématérialisation Partenaires **Différences avec la version synchrone :** - ✅ **Non-bloquant** : Retourne immédiatement un `id_tache` (HTTP 202 Accepted) - ✅ **Traitement en arrière-plan** : La facture est traitée par un worker Celery - ✅ **Suivi d'avancement** : Utilisez `/taches/{id_tache}/statut` pour suivre le statut - ✅ **Idéal pour gros volumes** : Permet de traiter de nombreuses factures en parallèle **Comment utiliser :** 1. **Soumission** : Appelez cet endpoint avec vos données de facture 2. **Retour immédiat** : Vous recevez un `id_tache` (ex: \"abc123-def456\") 3. **Suivi** : Appelez `/taches/{id_tache}/statut` pour vérifier l'avancement 4. **Résultat** : Quand `statut = \"SUCCESS\"`, le champ `resultat` contient la réponse complète **Credentials et signature** : Mêmes modes que la version synchrone (JWT ou payload).
|
|
92
|
-
# @param soumettre_facture_complete_request [SoumettreFactureCompleteRequest]
|
|
93
|
-
# @param [Hash] opts the optional parameters
|
|
94
|
-
# @return [ReponseTache]
|
|
95
|
-
def soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post(soumettre_facture_complete_request, opts = {})
|
|
96
|
-
data, _status_code, _headers = soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post_with_http_info(soumettre_facture_complete_request, opts)
|
|
97
|
-
data
|
|
98
|
-
end
|
|
99
|
-
|
|
100
|
-
# Soumettre une facture complète (asynchrone avec Celery)
|
|
101
|
-
# Version asynchrone de l'endpoint `/factures/soumettre-complete` utilisant Celery pour le traitement en arrière-plan. **Workflow automatisé (identique à la version synchrone) :** 1. **Auto-enrichissement** (optionnel) : récupère les données via APIs publiques et Chorus Pro/AFNOR 2. **Génération PDF Factur-X** : crée un PDF/A-3 avec XML embarqué 3. **Signature électronique** (optionnelle) : signe le PDF avec un certificat 4. **Soumission** : envoie vers la destination choisie (Chorus Pro ou AFNOR PDP) **Destinations supportées :** - **Chorus Pro** : plateforme B2G française (factures vers secteur public) - **AFNOR PDP** : Plateformes de Dématérialisation Partenaires **Différences avec la version synchrone :** - ✅ **Non-bloquant** : Retourne immédiatement un `id_tache` (HTTP 202 Accepted) - ✅ **Traitement en arrière-plan** : La facture est traitée par un worker Celery - ✅ **Suivi d'avancement** : Utilisez `/taches/{id_tache}/statut` pour suivre le statut - ✅ **Idéal pour gros volumes** : Permet de traiter de nombreuses factures en parallèle **Comment utiliser :** 1. **Soumission** : Appelez cet endpoint avec vos données de facture 2. **Retour immédiat** : Vous recevez un `id_tache` (ex: \"abc123-def456\") 3. **Suivi** : Appelez `/taches/{id_tache}/statut` pour vérifier l'avancement 4. **Résultat** : Quand `statut = \"SUCCESS\"`, le champ `resultat` contient la réponse complète **Credentials et signature** : Mêmes modes que la version synchrone (JWT ou payload).
|
|
102
|
-
# @param soumettre_facture_complete_request [SoumettreFactureCompleteRequest]
|
|
103
|
-
# @param [Hash] opts the optional parameters
|
|
104
|
-
# @return [Array<(ReponseTache, Integer, Hash)>] ReponseTache data, response status code and response headers
|
|
105
|
-
def soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post_with_http_info(soumettre_facture_complete_request, opts = {})
|
|
106
|
-
if @api_client.config.debugging
|
|
107
|
-
@api_client.config.logger.debug 'Calling API: ProcessingEndpointsUnifisApi.soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post ...'
|
|
108
|
-
end
|
|
109
|
-
# verify the required parameter 'soumettre_facture_complete_request' is set
|
|
110
|
-
if @api_client.config.client_side_validation && soumettre_facture_complete_request.nil?
|
|
111
|
-
fail ArgumentError, "Missing the required parameter 'soumettre_facture_complete_request' when calling ProcessingEndpointsUnifisApi.soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post"
|
|
112
|
-
end
|
|
113
|
-
# resource path
|
|
114
|
-
local_var_path = '/api/v1/traitement/factures/soumettre-complete-async'
|
|
115
|
-
|
|
116
|
-
# query parameters
|
|
117
|
-
query_params = opts[:query_params] || {}
|
|
118
|
-
|
|
119
|
-
# header parameters
|
|
120
|
-
header_params = opts[:header_params] || {}
|
|
121
|
-
# HTTP header 'Accept' (if needed)
|
|
122
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
123
|
-
# HTTP header 'Content-Type'
|
|
124
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
125
|
-
if !content_type.nil?
|
|
126
|
-
header_params['Content-Type'] = content_type
|
|
127
|
-
end
|
|
128
|
-
|
|
129
|
-
# form parameters
|
|
130
|
-
form_params = opts[:form_params] || {}
|
|
131
|
-
|
|
132
|
-
# http body (model)
|
|
133
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(soumettre_facture_complete_request)
|
|
134
|
-
|
|
135
|
-
# return_type
|
|
136
|
-
return_type = opts[:debug_return_type] || 'ReponseTache'
|
|
137
|
-
|
|
138
|
-
# auth_names
|
|
139
|
-
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
140
|
-
|
|
141
|
-
new_options = opts.merge(
|
|
142
|
-
:operation => :"ProcessingEndpointsUnifisApi.soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post",
|
|
143
|
-
:header_params => header_params,
|
|
144
|
-
:query_params => query_params,
|
|
145
|
-
:form_params => form_params,
|
|
146
|
-
:body => post_body,
|
|
147
|
-
:auth_names => auth_names,
|
|
148
|
-
:return_type => return_type
|
|
149
|
-
)
|
|
150
|
-
|
|
151
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
152
|
-
if @api_client.config.debugging
|
|
153
|
-
@api_client.config.logger.debug "API called: ProcessingEndpointsUnifisApi#soumettre_facture_complete_async_api_v1_traitement_factures_soumettre_complete_async_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
-
end
|
|
155
|
-
return data, status_code, headers
|
|
156
|
-
end
|
|
157
|
-
end
|
|
158
|
-
end
|