Wiki source code of PayEx Connect (API)
Last modified by Fredrik Nilsson on 2023/03/24 09:42
 |
8.1 | 1 | (% class="box infomessage" id="H" %) |
| 2 | ((( | ||
| 3 | **N.B. **This page describes legacy API integration that are still in use but is not implemented for new customers. Implementation guide for PayEx Invoice Service API:s is found [[here>>doc:Main.Invoicing.invoice-service.invoice-service-apis.WebHome]] | ||
| 4 | ))) | ||
| |
1.1 | 5 | |
| 6 | (% class="jumbotron" %) | ||
| 7 | ((( | ||
| 8 | (% class="container" %) | ||
| 9 | ((( | ||
| 10 | PayEx Connect API enables integrated access to PayEx services in a controlled and secure manner. This documentation targets technical system integrators and developers implementing the PayEx Connect API, that enable customers to access legacy services in a controlled and secure manner. | ||
| 11 | ))) | ||
| 12 | ))) | ||
| 13 | |||
| |
2.1 | 14 | == Overview == |
| 15 | |||
| |
1.1 | 16 | PayEx Connect use standard 128 bit SSL encryption to secure the communication channel. Client authentication is managed through UsernameTokens and IP filtering. |
| 17 | |||
| 18 | {{warning}} | ||
| 19 | The only protocol supported is Http Soap. Http Get and Http post is not allowed. | ||
| 20 | {{/warning}} | ||
| 21 | |||
| 22 | The picture below gives an architectual overview. | ||
| 23 | |||
| 24 | [[image:https://developer.payex.com/xwiki/wiki/developer/download/Main/Invoicing-copy/invoice-service-overview/technical-reference/payex-connect-overview/WebHome/architectural_overview.jpg||alt="architectural_overview.jpg"]] | ||
| 25 | |||
| 26 | |||
| 27 | PayEx Connect authenticates the client using a ##UsernameToken## security token. The SOAP message is not encrypted or digitally signed, the transportation is secured and encrypted through SSL. Microsoft Asp.Net clients can use the UsernameOverTransportAssertion defined in WSE 3.0 to create and manage UsenameTokens. | ||
| 28 | |||
| 29 | [[image:https://developer.payex.com/xwiki/wiki/developer/download/Main/Invoicing-copy/invoice-service-overview/technical-reference/payex-connect-overview/WebHome/security.jpg||alt="security.jpg"]] | ||
| 30 | |||
| 31 | ---- | ||
| 32 | |||
| |
2.1 | 33 | == Structure of this documentation == |
| |
1.1 | 34 | |
| 35 | This documentation contains several parts, as described below. | ||
| 36 | |||
| 37 | == The implementation manual == | ||
| 38 | |||
| |
5.1 | 39 | [[Learn what you need to do prior to integrating a system with PayEx Connect.>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).Commonimplementationsmanual.WebHome]] This section cover necessary prerequisites, implementation, security and error handling. |
| |
1.1 | 40 | |
| 41 | == The sample service manual == | ||
| 42 | |||
| |
7.1 | 43 | [[This manual cover web methods used in sample scenarios.>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).SampleServicemanual.WebHome]] |
| |
1.1 | 44 | |
| 45 | == The external services manual == | ||
| 46 | |||
| |
6.1 | 47 | [[This manual covers integration with PayEx Invoice Services.>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome]] |
| |
1.1 | 48 | |
| 49 | Learn about following methods: | ||
| 50 | |||
| 51 | * Get Invoice Information | ||
| 52 | * Get Invoice document in the format of PDF | ||
| 53 | * Get Customer Information | ||
| |
4.1 | 54 | * Register invoice/customer action |