https://github.com/backbase/mx-api-client
A backend accelerator library supporting integrations for MX external account aggregation
https://github.com/backbase/mx-api-client
accelerators backend
Last synced: 3 months ago
JSON representation
A backend accelerator library supporting integrations for MX external account aggregation
- Host: GitHub
- URL: https://github.com/backbase/mx-api-client
- Owner: Backbase
- Created: 2022-10-11T18:37:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-11T18:41:34.000Z (over 2 years ago)
- Last Synced: 2025-02-25T22:47:23.596Z (3 months ago)
- Topics: accelerators, backend
- Language: Java
- Homepage:
- Size: 823 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# mx-api-client
This project contains a client library that can be used to call MX external account aggregation web services.
This project can be utilized in your Backbase integration services as a Maven dependency. Simply include the following
maven coordinates in the `dependency` section of your service's `pom.xml`
```aidl
com.backbase.accelerators
mx-api-client
1.0.0
```
## Build this project
From the root directory of this project, run:
```mvn clean install```
This will compile the project.
| MX API | Environment | URL |
|---------------|-------------|-----------------------------------|
| MDX Real Time | NON-PROD | https://int-live.moneydesktop.com |
| MDX Real Time | PROD | https://live.moneydesktop.com |
| SSO | NON-PROD | https://int-sso.moneydesktop.com |
| SSO | PROD | https://sso.moneydesktop.com |
### Example usage - Defining `application.yml` configuration:
```yaml
mx:
ssoBaseUrl: https://int-sso.moneydesktop.com
realTimeBaseUrl: https://int-live.moneydesktop.com
nexusBaseUrl: https://int-data.moneydesktop.com
clientId: TBD
mdApiKey: TBD
```
```java
@Data
@Configuration
@ConfigurationProperties("mx")
public class MxProperties {
private String ssoBaseUrl;
private String realTimeBaseUrl;
private String nexusBaseUrl;
private String clientId;
private String mdApiKey;
public MxRequestSettings toMxRequestSettings() {
return new MxRequestSettings()
.setSsoBaseUrl(ssoBaseUrl)
.setRealTimeBaseUrl(realTimeBaseUrl)
.setNexusBaseUrl(nexusBaseUrl)
.setMdApiKey(mdApiKey)
.setClientId(clientId);
}
}
```
### Example usage - Defining a Spring Bean in Your Integration Service:
```java
@Configuration
public class MxApiClientConfiguration {
@Bean
public MxSsoClient mxSsoClient(MxProperties mxProperties) {
return new MxSsoClient(
HttpClient.newHttpClient(),
mxProperties.toMxRequestSettings());
}
@Bean
public MxNexusClient mxNexusClient(MxProperties mxProperties) {
return new MxNexusClient(
HttpClient.newHttpClient(),
mxProperties.toMxRequestSettings());
}
@Bean
public MxRealTimeClient mxRealTimeClient(MxProperties mxProperties) {
return new MxRealTimeClient(
HttpClient.newHttpClient(),
mxProperties.toMxRequestSettings());
}
}
```
### Example usage - Creating an Mx User Id:
There is a static utility class `com.backbase.acclerators.mx.util.MxUtil` that will create the mxUserId according to the
pattern `"BB"_[Environment]_([SA ExternalID] + [Identity idp.sub]).hashCode()`.