brand4impact-java-client

Total API Reference

• API version: 0.0.1
  • Build date: 2022-03-31T15:35:43.909+02:00[Europe/Paris]

Este contrato se usara para generar los clientes con todos los servicios necesarios.

!Uso exclusivo interno!

---

For more information, please visit http://www.brand4impact.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. 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>com.brand4impact</groupId>
  <artifactId>brand4impact-java-client</artifactId>
  <version>0.0.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.brand4impact:brand4impact-java-client:0.0.1"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/brand4impact-java-client-0.0.1.jar
• target/lib/*.jar

Getting Started

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

// Import classes:
import com.brand4impact.client.invoker.ApiClient;
import com.brand4impact.client.invoker.ApiException;
import com.brand4impact.client.invoker.Configuration;
import com.brand4impact.client.invoker.auth.*;
import com.brand4impact.client.invoker.models.*;
import com.brand4impact.client.api.AssetApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:8080/backend");
    
    // Configure HTTP bearer authorization: BearerAuthentication
    HttpBearerAuth BearerAuthentication = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuthentication");
    BearerAuthentication.setBearerToken("BEARER TOKEN");

    AssetApi apiInstance = new AssetApi(defaultClient);
    String token = "token_example"; // String | The unique token for the asset.
    try {
      PlatformAsset result = apiInstance.getAsset(token);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AssetApi#getAsset");
      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://localhost:8080/backend

Class	Method	HTTP request	Description
AssetApi	getAsset	GET /rest/platform/asset/{token}	Get a single asset
AssetApi	getAssets	GET /rest/platform/asset	Get a set of assets
CampaignApi	createCampaign	POST /rest/platform/campaign	Create a new campaign
CampaignApi	getCampaign	GET /rest/platform/campaign/{token}	Get a single campaign
CampaignApi	getCampaigns	GET /rest/platform/campaign	Get a set of campaigns
CampaignApi	switchCampaign	PUT /rest/platform/campaign/{token}/switch	Switch campaign status
CampaignApi	updateCampaign	PUT /rest/platform/campaign/{token}	Update a campaign
CompanyApi	createCompany	POST /rest/platform/company	Create a new Company
CompanyApi	getCompany	GET /rest/platform/company	Get your Company
CompanyApi	updateCompany	PUT /rest/platform/company	Update Company data
CompanyApi	updateCompanyLegal	PUT /rest/platform/company/legal	Update legal Company info
CompanyApi	updateCompanyTopic	PUT /rest/platform/company/topic	Update selected topics for your Company
InvoiceApi	getInvoice	GET /rest/platform/invoice/{token}	Get a single invoice
InvoiceApi	getInvoices	GET /rest/platform/invoice	Get a set of invoices
NgoApi	createNgo	POST /rest/platform/ngo	Create a new NGO
NgoApi	getNgo	GET /rest/platform/ngo	Get your NGO
NgoApi	updateNgo	PUT /rest/platform/ngo	Update NGO data
NgoApi	updateNgoBank	PUT /rest/platform/ngo/bank	Update bank NGO info
NgoApi	updateNgoLegal	PUT /rest/platform/ngo/legal	Update legal NGO info
NgoApi	uploadNgoFiles	PUT /rest/platform/ngo/upload	Upload NGO files
ProjectApi	createProject	POST /rest/platform/project	Create a new project
ProjectApi	getProject	GET /rest/platform/project/{token}	Get a single project
ProjectApi	getProjects	GET /rest/platform/project	Get a set of projects
ProjectApi	switchProject	PUT /rest/platform/project/{token}/switch	Switch project status
ProjectApi	updateProject	PUT /rest/platform/project/{token}	Update a project
SectorApi	getSector	GET /rest/platform/sector/{token}	Get a single sector
SectorApi	getSectors	GET /rest/platform/sector	Get a set of sectors
SecurityApi	getJWTToken	GET /security/jwt	get JWT token
TopicApi	getTopic	GET /rest/platform/topic/{token}	Get a single topic
TopicApi	getTopics	GET /rest/platform/topic	Get a set of topics
UserApi	changeUserPassword	PUT /rest/platform/user/{token}/changepassword	Change user's password
UserApi	confirmUser	POST /rest/platform/user/{token}	Activate a user
UserApi	getUser	GET /rest/platform/user/{token}	Get a single user
UserApi	getUsers	GET /rest/platform/user	Get a set of users
UserApi	inviteUser	POST /rest/platform/user/invite	Invite a new user
UserApi	resetUserPassword	PUT /rest/platform/user/resetpassword	Reset user's password
UserApi	switchUser	PUT /rest/platform/user/{token}/switch	Switch user's status
UserApi	updateUser	PUT /rest/platform/user/{token}	Update user data
UserApi	updateUserExt	PUT /rest/platform/user/{token}/ext	Update sensitive user data
UtilsApi	getCountries	GET /rest/platform/utils/country	Get countries
UtilsApi	getCurrencies	GET /rest/platform/utils/currency	Get currencies
UtilsApi	getLanguages	GET /rest/platform/utils/language	Get languages
UtilsApi	getRoles	GET /rest/platform/utils/roles	Get roles
UtilsApi	getZones	GET /rest/platform/utils/zone	Get zones
VoucherApi	downloadVoucherQr	GET /rest/platform/voucher/{token}/qr	Download the voucher QR image
VoucherApi	downloadVouchersFile	GET /rest/platform/voucher/campaign/{campaignToken}/file	Download a set of voucher's links file
VoucherApi	downloadVouchersQr	GET /rest/platform/voucher/campaign/{campaignToken}/qr	Download a set of voucher QR images
VoucherApi	getVoucher	GET /rest/platform/voucher/{token}	Get a single voucher
VoucherApi	getVouchers	GET /rest/platform/voucher/campaign/{campaignToken}	Get a set of vouchers

Documentation for Models

• ApiSort
• Pagination
• PlatformAsset
• PlatformAssetItem
• PlatformAssetItemWrapper
• PlatformCampaign
• PlatformCampaignItem
• PlatformCampaignItemWrapper
• PlatformCompany
• PlatformCompanyAddress
• PlatformCompanyLegal
• PlatformCompanyLegalAddress
• PlatformCountry
• PlatformCurrency
• PlatformInvoice
• PlatformInvoiceEntry
• PlatformInvoiceEntryBase
• PlatformInvoiceItem
• PlatformInvoiceItemWrapper
• PlatformLanguage
• PlatformNgo
• PlatformNgoAddress
• PlatformNgoLegal
• PlatformNgoLegalAddress
• PlatformProject
• PlatformProjectItem
• PlatformProjectItemWrapper
• PlatformRole
• PlatformSector
• PlatformSectorItem
• PlatformSectorItemWrapper
• PlatformTopic
• PlatformTopicItem
• PlatformTopicItemWrapper
• PlatformUser
• PlatformUserItem
• PlatformUserItemWrapper
• PlatformVoucher
• PlatformVoucherItem
• PlatformVoucherItemWrapper
• PlatformZone
• RestError
• SecurityUser

Documentation for Authorization

Authentication schemes defined for the API:

BasicAuthentication

• Type: HTTP basic authentication

BearerAuthentication

• Type: HTTP basic authentication

Recommendation

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

Author

support@brand4impact.com