Chorus Pro offers two connecting modes to the structures issuing and receiving invoices :
- EDI ( Electronic Data Interchange)
- API (Applicative Programing Interface)
These services facilitate the submission, the retrieval and the processing of invoices. Their activation requires a connection between the financial information system of these structures and Chorus Pro.
A "EDI and API connections" dedicated area is available on the Chorus Pro portal. It allows an automatic connection request to Chorus Pro.
SCOPE AND PREREQUISITES
The connection to Chorus Pro is done in two stages :
- A connection to the qualification environment ;
- A connection to the production environment.
This guide presents how to make a connection to the production environment. Regarding the qualification environment, please refer to the operating mode dedicated to the Chorus Pro Community qualification environment. The Community also contains details of the entire connection process.
All structures issuing or receiving invoices can request a connection to Chorus Pro, whether they are public or private structures. The creation of a connection form requires:
• To have read the technical documentation (in particular the sections):
o external specifications
o use Chorus pro in EDI mode
o OR use Chorus Pro in API mode
• For an EDI connection, have a valid digital certificate
• Have all the technical information for configuring the connection, in particular:
o in EDI: connection protocol, IP address, etc.
o in API: PISTE application code.
For structures to be connected in API, the creation of a technical user is also a prerequisite.
Before connecting to Chorus Pro in production, it is recommended to have made a connection for qualification, unless the publisher of the IT solution used by the structure is already connected for qualification.
The structures relying on a dematerialization operator (including thirds of remote transmission approved for communities and public establishments in EDI) have no connection request to make
Structures relying on a third party tele transmission have no connection request to make (since the third party has already handled it).
Structures wishing to connect in API mode must create a technical user directly from the Chorus Pro solution.
The creation of a technical user profile is detailed in the user guide Administer structures and users (section : in section 4.3 - Attaching a technical user to a structure)
To access Chorus Pro and to create a connection form, you must :
- Have a user account
- Have a structure file
The primary or secondary manager of the structure must have :
- Set the EDI and API connections area
- Connected at least one user to this area
If you are not the primary or secondary manager of the structure, it is possible to :
- Ask for a connection to the structure
- Ask for a subscription to the EDI & API connections area
The use of the connection environment feature is very occasional, and its features are very specific. We therefore recommend to greatly restrict the number of users entitled to this area.
It is therefore possible to limit this to a manager (primary or secondary) and to a user (who can have a more technical profile).
To use the EDI & API connections area on a structure, the primary or secondary manager must activate the area from the Manager activities tab.
Determine the structure for which the connection area is to be added, then click on the Pencil icon.
In the Areas block, select Add areas.
Select the access rights to the EDI & API connections area by checking Modify.
Validate the entry by clicking on the Validate button at the bottom of the page.
The EDI & API connections area is active and is visible in the upper banner of Chorus Pro for the manager(s) of the structure after the user reconnects.
Following activation of the Connection Area, users of the structure can request to subscribe to it. The subscription of a user space is done in two steps:
1. The user makes a request for subscription to the space EDI connections and PLC
2. The subscription request is validated by a manager
To make a connection request, users select the My account tab in the top banner.
On the block My areas subscriptions, click on add a subscription .
The user selects the structure concerned by his request, then selects EDI and API connection in the Area field.
Depending on the requested rights, the fields Show and/or Modification are selected.
The request is submitted by clicking on Validate.
After the creation of the connection request, a manager of the structure can validate it from the Manager activities tab in the top banner.
The manager selects the connection requests to be validated by ticking on the box, then validates the connection by clicking on Validate.
In the banner, click on EDI and API connections.
If the link to the Connection area is not visible, please check the settings of your account and structure referring to the prerequisites.
Clicking the EDI and API connections tab will open the active tab list for this feature (by default the displayed tab is Homepage).
Select Create EDI connection to access the creation of an EDI connection form.
When creating a connection form, it is necessary to provide a valid certificate that meets the technical requirements of a connection to Chorus Pro. These requirements are detailed in the Certificates document available on the Chorus Pro Community.
Type of certificate :
• Client and server for PeSIT EDI connections
• Server for EDI AS2 connections
• Client for EDI SFTP connections
List of suppliers : A link in the certificate document refers to the list of certificate suppliers (LSTI list).
Certificate format : Certificates must be sent in pkcs 7 format with the entire chain of certification.
Please note: The same certificate cannot be used for several connections, even for different structures.
Select the structure for which the connection form is generated using the Partner field, then confirm the Connection protocol to be used.
Using the Browse button, download the certificate(s) from your computer (depending on the connection protocol selected, the number of certificates may vary).
Validate your entry by clicking on Certificate(s) checking.
The connection protocols that can be used in EDI mode on Chorus pro are :
- PeSIT - Protocole Echanges Système Interbancaire Télécompensation
- SFTP - Secure File Transfer Protocol
- AS2 - Applicability Statement 2
Into these fields :
- General information : Confirm the period of validity of the connection.
- Certificate(s): Check the data of the downloaded certificate.
- Technical contact : Fill in the contact information of the person in charge of the technical connection. If needed, Chorus Pro support can contact the person.
- Network characteristics : read the network setting information to be used and complete it if needed.
- Interface codes : the following screen offers the possibility to select the EDI flows for which a connection will be made.
The available data flows in EDI mode are detailed in the table below. Certain flow choices are not proposed for connections in production (in green below) since it does not directly concern entities that connect :
For each interface code, you need to confirm the processing modes to implement :
- No connection : No connection for the flow
- Complete : Connection to the flow, an error on one of the parts of an incoming flow, causes the rejection of the whole flow (1 invoice in error on a batch of 100 invoices causes the rejection of all the invoices )
- Partial : Connection for the flow, an error on one of the parts of an incoming flow, does not lead to the rejection of the whole flow (1 invoice in error on a batch of 100 invoices, prevents the integration of the invoice in error but does not block the integration of the other 99 parts).
- Comments : The Comments field allows you to contextualize your connection form.
- Submission : Click Submit to send the form. The Save button allows you to keep a draft of your form without transmitting it for processing.
- Send : Select Confirm and submit to send the connection form.
Click on Search EDI connection tab in the top banner.
Enter a Search criteria from those available (eg : Partner).
Start the research by clicking on Search.
The Results of the research are displayed at the bottom of the page. They can be exported by clicking on the button Export results.
Connection forms can also have the following status :
- Sent Updated
Connection forms with a draft status can be modified by clicking on the Pencil icon.
Since mid-January 2020, the creation of a new API connection in certificate mode is no longer possible.
Only certificate renewal is possible on an existing connection. New PLC connections must be made in Oauth2 mode.
In case of difficulty, please contact the Chorus Pro support team.
In order to make an API Chorus Pro call, it is imperative that the user first:
- Has created an account in PISTE by selecting the UNIVERSAL organization on which the API Chorus Pro is located.
- Has created its application in PISTE
These steps are described in the PISTE user guide made available to platform users.
Reference document available on the PISTE website:
UserGuide_navigation (Version du 13/09/19)
This guide describes the steps to perform in Chorus Pro to declare its API connection in Chorus Pro.
Before this declaration, it is important to have fulfilled the prerequisites below:
- Have a Chorus Pro account
- Be attached to a structure
- Create a technical account
- Have the EDI & API Connection space open for modification
2.1 Declaration of a PISTE connection
In order to declare a PISTE connection, the connected user must:
- Click on the EDI & API Connection space
- Click on Manage my connections
- Click on Declare a PISTE connection located at the bottom of the page as illustrated above.
The PISTE connection entry page is displayed.
- Fill in the data with particular attention to the Name field of the PISTE application. This field must be filled in with the value entered in PISTE during the application creation step. Respect for case sensitivity is important because it is decisive for the success of future API calls.
- The user must also enter the type of use by selecting it from a drop-down list. If he indicates that he is a user of a publisher or operator solution, he is asked to indicate the name of the publisher / operator.
- After entering the data, confirm the connection, which changes to ACTIVE.
Click Manage API connection in the top banner.
By default, all connections are displayed, in certificate mode as in PISTE mode. Depending on whether it is a connection in certificate or Oauth2 mode, you may need to filter on Structure and current state, either in the upper part of the screen (connection by certificate), or in the lower part (connection in Oauth2 - PISTE mode)
Last Update: January 17, 2020