factpulse 3.0.23 → 3.0.25
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/AFNORPDPPADirectoryServiceApi.md +96 -286
- data/docs/ChorusProCredentials.md +8 -8
- data/docs/ChorusProDestination.md +1 -1
- data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +26 -0
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetStructureRequest.md +1 -1
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +18 -105
- data/lib/factpulse/helpers/client.rb +38 -9
- data/lib/factpulse/models/chorus_pro_credentials.rb +26 -94
- data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
- data/lib/factpulse/models/{facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb → facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb} +97 -29
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +1 -1
- data/lib/factpulse/models/get_invoice_request.rb +1 -1
- data/lib/factpulse/models/get_structure_request.rb +1 -1
- data/lib/factpulse/models/search_structure_request.rb +1 -1
- data/lib/factpulse/models/submit_invoice_request.rb +1 -1
- data/lib/factpulse/version.rb +1 -1
- data/lib/factpulse.rb +1 -5
- metadata +3 -11
- data/docs/AcceptLanguage.md +0 -15
- data/docs/DirectoryLineInclude.md +0 -15
- data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +0 -26
- data/docs/RoutingCodeInclude.md +0 -15
- data/docs/SiretInclude.md +0 -15
- data/lib/factpulse/models/accept_language.rb +0 -40
- data/lib/factpulse/models/directory_line_include.rb +0 -42
- data/lib/factpulse/models/routing_code_include.rb +0 -40
- data/lib/factpulse/models/siret_include.rb +0 -39
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: factpulse
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0.
|
|
4
|
+
version: 3.0.25
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAPI-Generator
|
|
@@ -216,7 +216,6 @@ files:
|
|
|
216
216
|
- docs/AFNORWebhookCallbackContent.md
|
|
217
217
|
- docs/APIError.md
|
|
218
218
|
- docs/APIProfile.md
|
|
219
|
-
- docs/AcceptLanguage.md
|
|
220
219
|
- docs/AcknowledgmentStatus.md
|
|
221
220
|
- docs/AdditionalDocument.md
|
|
222
221
|
- docs/AggregatedPaymentInput.md
|
|
@@ -250,7 +249,6 @@ files:
|
|
|
250
249
|
- docs/CurrencyCode.md
|
|
251
250
|
- docs/DeliveryParty.md
|
|
252
251
|
- docs/Destination.md
|
|
253
|
-
- docs/DirectoryLineInclude.md
|
|
254
252
|
- docs/DocType.md
|
|
255
253
|
- docs/DocumentConversionApi.md
|
|
256
254
|
- docs/DocumentTypeInfo.md
|
|
@@ -265,8 +263,8 @@ files:
|
|
|
265
263
|
- docs/ExtractionInfo.md
|
|
266
264
|
- docs/FacturXInvoice.md
|
|
267
265
|
- docs/FacturXPDFInfo.md
|
|
266
|
+
- docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md
|
|
268
267
|
- docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md
|
|
269
|
-
- docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md
|
|
270
268
|
- docs/FieldStatus.md
|
|
271
269
|
- docs/FileInfo.md
|
|
272
270
|
- docs/FilesInfo.md
|
|
@@ -339,7 +337,6 @@ files:
|
|
|
339
337
|
- docs/ReportPeriod.md
|
|
340
338
|
- docs/ReportSender.md
|
|
341
339
|
- docs/RoundingAmount.md
|
|
342
|
-
- docs/RoutingCodeInclude.md
|
|
343
340
|
- docs/SchematronValidationError.md
|
|
344
341
|
- docs/SchemeID.md
|
|
345
342
|
- docs/SearchFlowRequest.md
|
|
@@ -352,7 +349,6 @@ files:
|
|
|
352
349
|
- docs/SignatureInfoAPI.md
|
|
353
350
|
- docs/SignatureParameters.md
|
|
354
351
|
- docs/SimplifiedInvoiceData.md
|
|
355
|
-
- docs/SiretInclude.md
|
|
356
352
|
- docs/StructureInfo.md
|
|
357
353
|
- docs/StructureParameters.md
|
|
358
354
|
- docs/StructureService.md
|
|
@@ -426,7 +422,6 @@ files:
|
|
|
426
422
|
- lib/factpulse/helpers/client.rb
|
|
427
423
|
- lib/factpulse/helpers/exceptions.rb
|
|
428
424
|
- lib/factpulse/helpers/helpers.rb
|
|
429
|
-
- lib/factpulse/models/accept_language.rb
|
|
430
425
|
- lib/factpulse/models/acknowledgment_status.rb
|
|
431
426
|
- lib/factpulse/models/additional_document.rb
|
|
432
427
|
- lib/factpulse/models/afnor_acknowledgement.rb
|
|
@@ -556,7 +551,6 @@ files:
|
|
|
556
551
|
- lib/factpulse/models/currency_code.rb
|
|
557
552
|
- lib/factpulse/models/delivery_party.rb
|
|
558
553
|
- lib/factpulse/models/destination.rb
|
|
559
|
-
- lib/factpulse/models/directory_line_include.rb
|
|
560
554
|
- lib/factpulse/models/doc_type.rb
|
|
561
555
|
- lib/factpulse/models/document_type_info.rb
|
|
562
556
|
- lib/factpulse/models/e_reporting_flow_type.rb
|
|
@@ -568,8 +562,8 @@ files:
|
|
|
568
562
|
- lib/factpulse/models/extraction_info.rb
|
|
569
563
|
- lib/factpulse/models/factur_x_invoice.rb
|
|
570
564
|
- lib/factpulse/models/factur_xpdf_info.rb
|
|
565
|
+
- lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb
|
|
571
566
|
- lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb
|
|
572
|
-
- lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb
|
|
573
567
|
- lib/factpulse/models/field_status.rb
|
|
574
568
|
- lib/factpulse/models/file_info.rb
|
|
575
569
|
- lib/factpulse/models/files_info.rb
|
|
@@ -639,7 +633,6 @@ files:
|
|
|
639
633
|
- lib/factpulse/models/report_period.rb
|
|
640
634
|
- lib/factpulse/models/report_sender.rb
|
|
641
635
|
- lib/factpulse/models/rounding_amount.rb
|
|
642
|
-
- lib/factpulse/models/routing_code_include.rb
|
|
643
636
|
- lib/factpulse/models/schematron_validation_error.rb
|
|
644
637
|
- lib/factpulse/models/scheme_id.rb
|
|
645
638
|
- lib/factpulse/models/search_flow_request.rb
|
|
@@ -652,7 +645,6 @@ files:
|
|
|
652
645
|
- lib/factpulse/models/signature_info_api.rb
|
|
653
646
|
- lib/factpulse/models/signature_parameters.rb
|
|
654
647
|
- lib/factpulse/models/simplified_invoice_data.rb
|
|
655
|
-
- lib/factpulse/models/siret_include.rb
|
|
656
648
|
- lib/factpulse/models/structure_info.rb
|
|
657
649
|
- lib/factpulse/models/structure_parameters.rb
|
|
658
650
|
- lib/factpulse/models/structure_service.rb
|
data/docs/AcceptLanguage.md
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# FactPulse::FactureElectroniqueRestApiSchemasProcessingChorusProCredentials
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **piste_client_id** | **String** | | [optional] |
|
|
8
|
-
| **piste_client_secret** | **String** | | [optional] |
|
|
9
|
-
| **chorus_login** | **String** | | [optional] |
|
|
10
|
-
| **chorus_password** | **String** | | [optional] |
|
|
11
|
-
| **sandbox_mode** | **Boolean** | [MODE 2] Use sandbox mode (default: True) | [optional][default to true] |
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'factpulse'
|
|
17
|
-
|
|
18
|
-
instance = FactPulse::FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.new(
|
|
19
|
-
piste_client_id: null,
|
|
20
|
-
piste_client_secret: null,
|
|
21
|
-
chorus_login: null,
|
|
22
|
-
chorus_password: null,
|
|
23
|
-
sandbox_mode: null
|
|
24
|
-
)
|
|
25
|
-
```
|
|
26
|
-
|
data/docs/RoutingCodeInclude.md
DELETED
data/docs/SiretInclude.md
DELETED
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#FactPulse REST API
|
|
3
|
-
|
|
4
|
-
# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
|
7
|
-
Contact: contact@factpulse.fr
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.19.0-SNAPSHOT
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'date'
|
|
14
|
-
require 'time'
|
|
15
|
-
|
|
16
|
-
module FactPulse
|
|
17
|
-
class AcceptLanguage
|
|
18
|
-
FR = "fr".freeze
|
|
19
|
-
EN = "en".freeze
|
|
20
|
-
|
|
21
|
-
def self.all_vars
|
|
22
|
-
@all_vars ||= [FR, EN].freeze
|
|
23
|
-
end
|
|
24
|
-
|
|
25
|
-
# Builds the enum from string
|
|
26
|
-
# @param [String] The enum value in the form of the string
|
|
27
|
-
# @return [String] The enum value
|
|
28
|
-
def self.build_from_hash(value)
|
|
29
|
-
new.build_from_hash(value)
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
# Builds the enum from string
|
|
33
|
-
# @param [String] The enum value in the form of the string
|
|
34
|
-
# @return [String] The enum value
|
|
35
|
-
def build_from_hash(value)
|
|
36
|
-
return value if AcceptLanguage.all_vars.include?(value)
|
|
37
|
-
raise "Invalid ENUM value #{value} for class #AcceptLanguage"
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
end
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#FactPulse REST API
|
|
3
|
-
|
|
4
|
-
# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
|
7
|
-
Contact: contact@factpulse.fr
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.19.0-SNAPSHOT
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'date'
|
|
14
|
-
require 'time'
|
|
15
|
-
|
|
16
|
-
module FactPulse
|
|
17
|
-
class DirectoryLineInclude
|
|
18
|
-
SIREN = "siren".freeze
|
|
19
|
-
SIRET = "siret".freeze
|
|
20
|
-
ROUTING_CODE = "routingCode".freeze
|
|
21
|
-
PLATFORM = "platform".freeze
|
|
22
|
-
|
|
23
|
-
def self.all_vars
|
|
24
|
-
@all_vars ||= [SIREN, SIRET, ROUTING_CODE, PLATFORM].freeze
|
|
25
|
-
end
|
|
26
|
-
|
|
27
|
-
# Builds the enum from string
|
|
28
|
-
# @param [String] The enum value in the form of the string
|
|
29
|
-
# @return [String] The enum value
|
|
30
|
-
def self.build_from_hash(value)
|
|
31
|
-
new.build_from_hash(value)
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# Builds the enum from string
|
|
35
|
-
# @param [String] The enum value in the form of the string
|
|
36
|
-
# @return [String] The enum value
|
|
37
|
-
def build_from_hash(value)
|
|
38
|
-
return value if DirectoryLineInclude.all_vars.include?(value)
|
|
39
|
-
raise "Invalid ENUM value #{value} for class #DirectoryLineInclude"
|
|
40
|
-
end
|
|
41
|
-
end
|
|
42
|
-
end
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#FactPulse REST API
|
|
3
|
-
|
|
4
|
-
# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
|
7
|
-
Contact: contact@factpulse.fr
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.19.0-SNAPSHOT
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'date'
|
|
14
|
-
require 'time'
|
|
15
|
-
|
|
16
|
-
module FactPulse
|
|
17
|
-
class RoutingCodeInclude
|
|
18
|
-
SIREN = "siren".freeze
|
|
19
|
-
SIRET = "siret".freeze
|
|
20
|
-
|
|
21
|
-
def self.all_vars
|
|
22
|
-
@all_vars ||= [SIREN, SIRET].freeze
|
|
23
|
-
end
|
|
24
|
-
|
|
25
|
-
# Builds the enum from string
|
|
26
|
-
# @param [String] The enum value in the form of the string
|
|
27
|
-
# @return [String] The enum value
|
|
28
|
-
def self.build_from_hash(value)
|
|
29
|
-
new.build_from_hash(value)
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
# Builds the enum from string
|
|
33
|
-
# @param [String] The enum value in the form of the string
|
|
34
|
-
# @return [String] The enum value
|
|
35
|
-
def build_from_hash(value)
|
|
36
|
-
return value if RoutingCodeInclude.all_vars.include?(value)
|
|
37
|
-
raise "Invalid ENUM value #{value} for class #RoutingCodeInclude"
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
end
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#FactPulse REST API
|
|
3
|
-
|
|
4
|
-
# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
|
7
|
-
Contact: contact@factpulse.fr
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.19.0-SNAPSHOT
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'date'
|
|
14
|
-
require 'time'
|
|
15
|
-
|
|
16
|
-
module FactPulse
|
|
17
|
-
class SiretInclude
|
|
18
|
-
SIREN = "siren".freeze
|
|
19
|
-
|
|
20
|
-
def self.all_vars
|
|
21
|
-
@all_vars ||= [SIREN].freeze
|
|
22
|
-
end
|
|
23
|
-
|
|
24
|
-
# Builds the enum from string
|
|
25
|
-
# @param [String] The enum value in the form of the string
|
|
26
|
-
# @return [String] The enum value
|
|
27
|
-
def self.build_from_hash(value)
|
|
28
|
-
new.build_from_hash(value)
|
|
29
|
-
end
|
|
30
|
-
|
|
31
|
-
# Builds the enum from string
|
|
32
|
-
# @param [String] The enum value in the form of the string
|
|
33
|
-
# @return [String] The enum value
|
|
34
|
-
def build_from_hash(value)
|
|
35
|
-
return value if SiretInclude.all_vars.include?(value)
|
|
36
|
-
raise "Invalid ENUM value #{value} for class #SiretInclude"
|
|
37
|
-
end
|
|
38
|
-
end
|
|
39
|
-
end
|