{"id":28577478,"url":"https://github.com/mastercard/credit-analytics-reference-app","last_synced_at":"2025-06-11T00:38:49.798Z","repository":{"id":38084083,"uuid":"502081727","full_name":"Mastercard/credit-analytics-reference-app","owner":"Mastercard","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-03T09:50:05.000Z","size":64,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-12-03T10:36:50.447Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mastercard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-10T14:54:35.000Z","updated_at":"2024-12-03T09:50:10.000Z","dependencies_parsed_at":"2024-10-16T19:44:08.692Z","dependency_job_id":"bf1e06c8-7d11-4ae0-8148-1bac1977e33a","html_url":"https://github.com/Mastercard/credit-analytics-reference-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fcredit-analytics-reference-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fcredit-analytics-reference-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fcredit-analytics-reference-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fcredit-analytics-reference-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mastercard","download_url":"https://codeload.github.com/Mastercard/credit-analytics-reference-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fcredit-analytics-reference-app/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259177332,"owners_count":22817349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-11T00:37:53.874Z","updated_at":"2025-06-11T00:38:49.759Z","avatar_url":"https://github.com/Mastercard.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Small Business Credit Analytics Reference App\n\n[![](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.txt)\n\n\n## Table of Contents\n- [Overview](#overview)\n- [Requirements](#requirements)\n- [Frameworks/Libraries](#frameworks)\n- [Integrating with OpenAPI Generator](#OpenAPI_Generator)\n- [Configuration](#configuration)\n- [Use-Cases](#use-cases)\n- [Execute the Use-Cases](#execute-the-use-cases)\n- [Service Documentation](#documentation)\n- [API Reference](#api-reference)\n- [Support](#support)\n- [License](#license)\n\n## Overview  \u003ca name=\"overview\"\u003e\u003c/a\u003e\nThis is a reference application to demonstrate how the Small Business Credit Analytics(SBCA) API is used.\nTo call the API, a consumer key and .p12 file are required - they can be obtained by creating a project\non https://developer.mastercard.com - see the Configuration section below for detailed instructions.\n\n## Requirements  \u003ca name=\"requirements\"\u003e\u003c/a\u003e\n\n- Java 11\n- IntelliJ IDEA (or any other IDE)\n\n## Frameworks/Libraries \u003ca name=\"frameworks\"\u003e\u003c/a\u003e\n- Apache Maven\n- OpenAPI Generator\n\n## Integrating with OpenAPI Generator \u003ca name=\"OpenAPI_Generator\"\u003e\u003c/a\u003e\n\nOpenAPI Generator generates API client libraries from OpenAPI Specs. It provides generators and library templates for supporting multiple languages and frameworks.\nCheck [Generating and Configuring a Mastercard API Client](https://developer.mastercard.com/platform/documentation/security-and-authentication/generating-and-configuring-a-mastercard-api-client/) to learn more about how to generate a simple API client for consuming APIs.\n\n## Configuration \u003ca name=\"configuration\"\u003e\u003c/a\u003e\n1. Create an account on [Mastercard Developers](https://developer.mastercard.com/) if you don't have one already.\n2. Once logged in, create a new project, add the ***Small Business Credit Analytics API*** to it, and click continue.\n3. Click the button to generate and download your private signing key - a ```.p12``` file will be downloaded.\n5. Copy the downloaded ```.p12``` file to the ```src/main/resources``` folder in your code.\n6. Open ```src/main/java/com/mastercard/creditanalytics/api/ApiExamples.java``` and configure the default ApiClient creation logic:\n  - ```apiBasePath```- This is the URL Path to the API endpoint, one of:\n    - For the sandbox environment, https://sandbox.api.mastercard.com/small-business/credit-analytics/locations\n    - For the production environment, https://api.mastercard.com/small-business/credit-analytics/locations\n  - ```signingKeyPath```- Path to the key (*.p12) file on your machine. If you placed the file in your `src/main/resources` directory, your path might look like `./src/main/resources/*.p12` to run locally.\n  - ```signingKeyAlias``` - The alias of your key. The default value for sandbox keys is ```keyalias```.\n  - ```signingKeyPassword``` -  The password for your Keystore. The default value for sandbox projects is ```keystorepassword```.\n  - ```consumerKey``` - This is your consumer key from the Sandbox Keys or Production Keys section of your project page.\n\n## Use-Cases \u003ca name=\"use-cases\"\u003e\u003c/a\u003e\n1. `/matches` **Match a merchant's details to Mastercard's locations database** \u003cbr/\u003e\n   Use this endpoint to retrieve potential matches to the merchant's provided name and address metadata in Mastercard's database.\n\n2. `/metrics/{location_id}` **Get performance metrics for a merchant** \u003cbr/\u003e\n   Use this endpoint to retrieve performance metrics for a matched merchant returned from /matches\n\nMore details can be found [here](https://developer.mastercard.com/small-business-credit-analytics/documentation/use-cases).\n\n\n## Execute the Use-Cases   \u003ca name=\"execute-the-use-cases\"\u003e\u003c/a\u003e\n1. Run ```mvn clean install``` from the root of the project directory.\n2. When the project builds successfully, you can run the following command to start the project: `java -jar target/creditanalytics-referenceapp-1.0.0.jar`\n3. This will start the application and run through a set of examples exercising all the use cases mentioned above\n\n## Service Documentation \u003ca name=\"documentation\"\u003e\u003c/a\u003e\n\nSmall Business Credit Analytics documentation can be found [here](https://developer.mastercard.com/small-business-credit-analytics/documentation/).\n\n\n## API Reference \u003ca name=\"api-reference\"\u003e\u003c/a\u003e\nThe OpenAPI specification can be found [here](https://developer.mastercard.com/small-business-credit-analytics/documentation/api-reference/).\n\n## Support \u003ca name=\"support\"\u003e\u003c/a\u003e\nPlease email **advisors.help@mastercard.com** with any questions or feedback you may have.\n\n## License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\u003cp\u003eCopyright 2021 Mastercard\u003c/p\u003e\n\u003cp\u003eLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with\nthe License. You may obtain a copy of the License at:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e   http://www.apache.org/licenses/LICENSE-2.0\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on\nan \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fcredit-analytics-reference-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmastercard%2Fcredit-analytics-reference-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fcredit-analytics-reference-app/lists"}