feat(FN-3163): automate new DTFS customer creation in Salesforce (D&B service only)

[natdeanlewissoftwire]

Introduction ✏️

As part of the CCM project, if a customer does exist in SF, we are automatically creating it rather than relying on the manual process currently undertaken by Business Support Group. DTFS will send requests to a new customer/salesforce endpoint for MDM to create a customer in Salesforce. Technical documentation of this process is here

The corresponding feature-flagged DTFS pull request is here

Resolution ✔️

This PR adds the Dun and Bradstreet service, and an endpoint to allow us to GET a company from Dun and Bradstreet by their registration number (in our case Companies House Number). This will then be used by this PR as part of the customer creation process.

Miscellaneous ➕

To be merged before the remainder of the customer creation endpoint.

Also adds a user facing D&B endpoint, viewable in the Swagger docs:

[abhi-markan]

Thanks @natdeanlewissoftwire looks good have few questions:

1. Should an API test also be added to perform an actual API call.
2. What is the MDM endpoint for this external call please?

[natdeanlewissoftwire]

Thanks @abhi-markan:

Should an API test also be added to perform an actual API call.

I think we should avoid this if possible as there's a limit on the number of calls we can make to the API in our plan (a few thousand iirc). Is there a standard practice that's followed in the codebase? Most of the codebases I've worked on mock this sort of external API test and trust the external provider to handle testing their endpoint, though I appreciate that comes with drawbacks on our end.

What is the MDM endpoint for this external call please?

There's actually no public endpoint for this, as it'll be encapsulated in the larger CreateOrGetParty endpoint (on '/customers' POST method). This will hopefully be apparent in the PR to follow this one! I did make a temporary endpoint in the swagger while I was testing this locally but it's not necessary to include here imo.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[abhi-markan]

One minor comment please.