top banner
phone with code

Developer
Docs

Getting started

HERE INTRODUCTION:

1. SF allows access to our tech

2. Introduction to what our tech can do

On this page

1. Authentication

2. OriginationAPI

1. Authentication

To be able to authenticate with SellersFunding APIs you first need a client account.
To create an account you need to do the following steps:

1. Apply

2. Second Step

3. Third Step

Once you have an account, your account manager will send you an API_KEY that will be used to authorize requests.
To do so you needto add this string as a header on any request to the API as follows:

x-api-key: API_KEY

Sample request:

GET /api/end-point/ HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: bm9bqcaX.py0ODEGwH8OHSXDgaaqvJmJbVYajmS92
Accept: application/json
Cache-Control: no-cache

2. OriginationAPI

INTRODUCTION TO THE API:

1. What do we want to accomplish with this API.

2. What are the use-cases for this API.

The OriginationAPI contains the following endpoints:

2.1 Origination Amount

This endpoint returns the origination amount for a marketplace seller calculated by SellersFunding technology and it is used as follows:

Endpoint:

GET /api/{seller_id}/origination-amount

Where seller_id should be replaced with the Amazon ID to query.

Sample request:

GET /api/ABC123DEF456/origination-amount/ HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
   "SellerId": "string",
   "OriginationAmount": float,
   "ProcessingDate": "YYYY-MM-DDT00:00:00",
   "ClientUrl": "string"
}

2.2 Visinger Score

This endpoint returns latest six entries for the Visinger Score, calculated monthly. This value is calculated using machine learning model which, based on reviews, generates a score:

Endpoint:

GET /api/{seller_id}/visinger

Where seller_id should be replaced with the Amazon ID to query.

Sample request:

GET /api/ABC123DEF456/origination-amount/ HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
   "SellerId": "string",
   "ClientUrl": "string",
   "VisingerHistory": [
      {
         "VisingerScore": int,
         "ProcessingDate": "string"
      },
      {
         "VisingerScore": int,
         "ProcessingDate": "YYYY-MM-DDT00:00:00"
      }
   ]
}

2.3 Visinger Sales Prediction

This endpoint returns a sales prediction based on the Visinger score which is also calculated using the machine learning model previously mentioned:

Endpoint:

GET /api/{seller_id}/visinger-sales-prediction/

Where seller_id should be replaced with the Amazon ID to query.

Sample request:

GET /api/ABC123DEF456/visinger-sales-prediction/ HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
   "SellerId": "string",
   "VisingerSalesPred": float,
   "ProcessingDate": "YYYY-MM-DDT00:00:00",
   "ClientUrl": "string"
}

2.4 Sales Forecast

This endpoint returns the result of a machine learning model which generates a sales forecast based on previous sales tendencies, ads investments, refund amounts and marketplace transfers:

Endpoint:

GET /api/{seller_id}/salesforecast/

Where seller_id should be replaced with the Amazon ID to query.

Sample request:

GET /api/ABC123DEF456/salesforecast/ HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
   "SellerId": "string",
   "ClientUrl": "string",
   "CurrencyCode": "string",
   "SalesPred180": float,
   "SalesPred90": float,
   "SalesPred30": float
}

2.5 Seller Valuation

This endpoint returns the result of a SellerFunding internal valutation for each seller:

Endpoint:

GET /api/{seller_id}/seller-valuation/

Where seller_id should be replaced with the Amazon ID to query.

Sample request:

GET /api/ABC123DEF456/seller-valuation/ HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
   "SellerId": "string",
   "ClientUrl": "string",
   "Last12MonthsSales": float,
   "LowValuation": float,
   "HighValuation": float
}

2.6 Seller Savings

This endpoint returns the total savings based on sales for a single seller:

Endpoint:

GET /api/seller-valuation/

Params:

"seller_id": "string"
"num_months": int
"currency": "string"

Sample request:

GET /api/seller-savings/?seller_id=ABC123DEF456&num_months=12¤cy=USD HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
"SellerId": "string",
"Months": int,
"Savings": [
{
"CurrencyCode": "string",
"SavingsAmount": float
}
]
}

2.7 Amount Savings

This endpoint returns the total savings based on a selected amount:

Endpoint:

GET /api/savings-amount/

Params:

"amount": float

Sample request:

GET /api/savings-amount/?amount=100000 HTTP/1.1
Host: visinger-origination.azurewebsites.net
x-api-key: API_KEY
Accept: application/json
Cache-Control: no-cache

Sample response:

{
"SavingsAmount": float
}
footer banner
Voltar ao topo