credit-scorecard-java-client

Fineract Credit Scorecard

API version: 0.1.0-SNAPSHOT

An API module for credit risk assessment

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

Java 1.8+
Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.apache.fineract</groupId>
  <artifactId>credit-scorecard-java-client</artifactId>
  <version>0.1.0-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.apache.fineract:credit-scorecard-java-client:0.1.0-SNAPSHOT"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

target/credit-scorecard-java-client-0.1.0-SNAPSHOT.jar
target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:


// Import classes:
import org.apache.fineract.credit.scorecard.ApiClient;
import org.apache.fineract.credit.scorecard.ApiException;
import org.apache.fineract.credit.scorecard.Configuration;
import org.apache.fineract.credit.scorecard.models.*;
import org.apache.fineract.credit.scorecard.services.AlgorithmsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:8000");

    AlgorithmsApi apiInstance = new AlgorithmsApi(defaultClient);
    Algorithm algorithm = new Algorithm(); // Algorithm | 
    try {
      Algorithm result = apiInstance.algorithmsCreate(algorithm);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlgorithmsApi#algorithmsCreate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:8000

Class	Method	HTTP request
AlgorithmsApi	algorithmsCreate	POST /api/v1/algorithms
AlgorithmsApi	algorithmsDestroy	DELETE /api/v1/algorithms/{id}
AlgorithmsApi	algorithmsList	GET /api/v1/algorithms
AlgorithmsApi	algorithmsPartialUpdate	PATCH /api/v1/algorithms/{id}
AlgorithmsApi	algorithmsPredict	POST /api/v1/algorithms/predict
AlgorithmsApi	algorithmsRetrieve	GET /api/v1/algorithms/{id}
AlgorithmsApi	algorithmsUpdate	PUT /api/v1/algorithms/{id}
DatasetsApi	datasetsList	GET /api/v1/datasets
DatasetsApi	datasetsRetrieve	GET /api/v1/datasets/{id}
RequestsApi	requestsCreate	POST /api/v1/requests
RequestsApi	requestsDestroy	DELETE /api/v1/requests/{id}
RequestsApi	requestsList	GET /api/v1/requests
RequestsApi	requestsPartialUpdate	PATCH /api/v1/requests/{id}
RequestsApi	requestsRetrieve	GET /api/v1/requests/{id}
RequestsApi	requestsUpdate	PUT /api/v1/requests/{id}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.