Platform Manager v1.1 Documentation

Icon API

Une fois que vous avez enregistré votre plateforme dans BrickFunding avec le plan Freemium, vous pourrez connecter gratuitement votre site de crowdfunding avec notre API et publier vos opportunités d'investissement sur notre site.

Pour ce faire, il suffit d'injecter l'information sur vos projets, en suivant les instructions ci-dessous, et de commencer à recevoir des investisseurs sans frais. Passez en revue toutes les données pour vous assurer d'un maximum d'exactitude et inciter nos investisseurs à vous choisir pour investir. Et, si vous le souhaitez, vous pouvez également injecter les informations de votre blog et chaque fois que vous publierez un nouvel article, nous le communiquerons à nos utilisateurs. Obtenez des prospects de qualité pour votre site Web gratuitement en vous connectant à notre API !

Si vous n'avez pas d'équipe technique et que vous avez besoin de nous pour développer votre propre API, ou si vous avez besoin d'aide pour implémenter l'intégration, contactez-nous et nous vous ferons un devis. Connectez-vous avec notre API ou donnez-nous accès à la vôtre et nous nous chargerons de l'intégration.

Avantages de l'utilisation de notre API

  • Vous pourrez publier vos projets : pour garantir la qualité des données que nous montrons, nous n'acceptons pas la publication manuelle des projets, nous ne publions que les projets qui sont injectés de manière automatisée via notre API. Et nos investisseurs apprécient beaucoup plus les plateformes qui présentent l'information de leurs projets. Ainsi, bien qu'avec votre Plan Freemium vous ne pouvez avoir que votre Carte Plate-forme et utiliser notre API, nous vous recommandons fortement d'injecter vos informations et de publier vos projets dans brickFunding !
  • Vous obtiendrez plus de trafic : le trafic que nous vous référons augmente jusqu'à 300%. Les plateformes qui listent leurs projets et articles avec nous via API reçoivent jusqu'à trois fois plus de visites que celles qui listent uniquement leur fichier de plateforme.
  • Vous serez mieux positionné dans nos annonces : le trafic que nous vous référons augmente jusqu'à 300%. Les plateformes qui listent leurs projets et articles avec nous via API reçoivent jusqu'à trois fois plus de visites que celles qui listent uniquement leur fichier de plateforme.
  • Vous pourrez publier vos articles : chaque fois que vous publiez un nouvel article dans votre blog, vous pouvez également nous injecter les informations de base à son sujet et un lien vers celui-ci apparaîtra dans votre fichier de plateforme et dans notre section news. Les investisseurs intéressés seront redirigés vers votre site Web pour lecture.
  • Vous apparaîtrez dans notre bulletin : chaque semaine, nous envoyons à nos utilisateurs une newsletter avec les derniers projets d'investissement et les articles qui ont été injectés dans notre API. Accédez facilement à des milliers d'investisseurs potentiels.
  • C'est gratuit : c'est le meilleur de tous, si vous enregistrez votre plateforme chez nous et intégrez vos informations via notre API vous pouvez obtenir tout cela gratuitement !
Imagen de BrickFunding

Si vous avez besoin de plus d'informations, n'hésitez pas à nous contacter. [email protected]

Platform Information

GET PLATFORM





METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/platform?apikey=Votre_clé_api_clé

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
data

Object containing the following properties:

idInternal ID
nameName
addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
emailEmail
phonePhone
foundationYear of foundation (4 digits)
facebookFacebook URL
twitterTwitter URL
linkedinLinkedIn URL
languageMain Language (ISO 639-1)
currencyMain Currency (ISO 4217)
createdCreation date (EPOCH milliseconds)
updatedUpdated date (EPOCH milliseconds)
languages

Object containing:

language (ISO 639-1)

One Object per language containing:

urlPlatforms URL
introPlatform's introduction (optional)
descriptionPlatform's description
payment

Object containing:

planSelected payment plan
currencyFee currency
feeCurrent fee
details

Object containing invoice details

addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
Platform's information


UPDATE PLATFORM

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/platform?apikey=Votre_clé_api_clé

REQUEST BODY: JSON

REQUEST PARAMS:

PropertyValueDescription
address (optional)StringAddress
pobox (optional)StringZIP Code
city (optional)StringCity
state (optional)StringState
country (optional)String (ISO Alpha-2 Code)Country
email (optional)String (Email)Email
phone (optional)StringPhone
foundation (optional)Integer (4 digits)Year of foundation
facebook (optional)String (URL)Facebook URL
twitter (optional)String (URL)Twitter URL
linkedin (optional)String (URL)LinkedIn URL
language (optional)String (ISO 639-1 Code)Main Language
currency (optional)String (ISO 4217 Code)Main Currency
languages (optional)

One Object per language (ISO 639-1 Code as Key) containing:

urlString (URL)Platforms URL
introString (optional)Platform's introduction (optional)
descriptionStringPlatform's description

Object containing data based on languages.

Example:

                        languages: {
                          en: {
                            url: "http://www.myplatform.com/en",
                            intro: "My intro",
                            description: "My long description"
                          },
                          es: {
                            url: "http://www.myplatform.com/es",
                            intro: "Una introducción",
                            description: "Una descripción larga"
                          }
                        }
                      

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
(optional) errorsArray of stringsList of errors detected


Projects Information



GET ALL PROJECTS

METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects?apikey=Votre_clé_api_clé

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
data (Array)

Array containing objects with the following properties:

idInternal ID
_scrapper_original_idYOUR Unique ID
nameName
addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
languageMain Language (ISO 639-1)
currencyMain Currency (ISO 4217)
statusProject's Status (open/close)
active1/0 (number) Published on website
completedCompleted percentage (0-100)
minimumMinimum investment amount
targetTarget amount
iniStarting Date (EPOCH milliseconds)
endEnding Date (EPOCH milliseconds)
finishedFunding finish date (EPOCH milliseconds)
investorsNumber of investors
grossGross Rate Percentage
netNet Rate Percentage
cocCash-On-Cash Rate Percentage
disinvestmentPeriod in months of disinvestment
createdCreation date (EPOCH milliseconds)
updatedUpdated date (EPOCH milliseconds)
imageInternal ID for Main Image
imagesArray of extra images (URLs)
languages

Object containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

url (required)String (URL)Project's URL
intro (optional)StringProject's introduction (optional)
description (required)StringProject's description
Projects's information


CREATE/UPDATE PROJECTS

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects?apikey=Votre_clé_api_clé

REQUEST TYPE: JSON

REQUEST:

PropertyValueDescription
projects

Array of Objects

PropertyValueDescription
id (required)StringYOUR Internal Project's ID
name (optional)StringName (required if new)
address (optional)StringAddress (required if new)
pobox (optional)StringZIP Code (required if new)
city (optional)StringCity (required if new)
state (optional)StringState (required if new)
country (optional)String (ISO Alpha-2)Country (required if new)
language (optional)String (ISO 639-1)Main Language (required if new)
asset (optional)residential-single, residential-block, commercial, hotel, industry, other)Type of Asset
type (optional)lending, equity, lending, share, fiduciary, saving, investment, hybridType of loan agreement
currency (optional)String (ISO 4217)Main Currency (required if new)
status (optional)String (open/close)Project's Status (required if new)
active (optional)Integer (1/0)Published on BF website (Yes=1 or No=0)
completed (optional)IntegerCompleted percentage (0-100) (required if new)
minimum (optional)FloatMinimum investment amount (required if new)
target (optional)FloatTarget amount (required if new)
ini (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDStarting Date (required if new)
end (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDEnding Date(blank for no ending)
finished (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDProject's Finished Funded Date (if status closed)
investors (optional)IntegerNumber of investors (required if new)
gross (optional)FloatGross Rate Percentage (required if new)
net (optional)FloatNet Rate Percentage (required if new)
coc (optional)FloatCash-On-Cash Rate Percentage (required if new)
disinvestment (optional)IntegerPeriod in months of disinvestment (required if new)
images (optional)Array (URLs)List of images URLs.
Note: First one will be the Main Image.
(required if new)
languages (optional)

One Object per language (ISO 639-1 Code as Key) containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

url (required)String (URL)Project's URL
intro (optional)StringProject's introduction (optional)
description (required)StringProject's description

(required if new)

Languages object with per language information.

Example:

                              languages: {
                                en: {
                                  url: "http://www.myplatform.com/en/myproject",
                                  intro: "My intro",
                                  description: "My long description"
                                },
                                es: {
                                  url: "http://www.myplatform.com/es/miproyecto",
                                  intro: "Una introducción",
                                  description: "Una descripción larga"
                                }
                              }
                            
Array of objects containing project's information

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
(optional) errorsArray of stringsList of errors detected


GET PROJECT

METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects/{PROJECTID}?apikey=Votre_clé_api_clé

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
data

Object containing the following properties:

idInternal ID
_scrapper_original_idYOUR Unique ID
nameName
addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
languageMain Language (ISO 639-1)
currencyMain Currency (ISO 4217)
statusProject's Status (open/close)
active1/0 (number) Published on website
completedCompleted percentage (0-100)
minimumMinimum investment amount
targetTarget amount
iniStarting Date (EPOCH milliseconds)
endEnding Date (EPOCH milliseconds)
finishedFunding finish date (EPOCH milliseconds)
investorsNumber of investors
grossGross Rate Percentage
netNet Rate Percentage
cocCash-On-Cash Rate Percentage
disinvestmentPeriod in months of disinvestment
createdCreation date (EPOCH milliseconds)
updatedUpdated date (EPOCH milliseconds)
imageInternal ID for Main Image
imagesArray (URLs) of extra images
languages

Object containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

urlProject's URL
introProject's introduction (optional)
descriptionProject's description
Projects's information


UPDATE PROJECT

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects/{PROJECTID}?apikey=Votre_clé_api_clé

REQUEST TYPE: JSON

REQUEST:

PropertyValueDescription
id (required)StringYOUR Internal Project's ID
name (optional)StringName
address (optional)StringAddress
pobox (optional)StringZIP Code
city (optional)StringCity
state (optional)StringState
country (optional)String (ISO Alpha-2)Country
language (optional)String (ISO 639-1)Main Language
asset (optional)residential-single, residential-block, commercial, hotel, industry, other)Type of Asset
type (optional)lending, equity, lending, share, fiduciary, saving, investment, hybridType of loan agreement
currency (optional)String (ISO 4217)Main Currency
status (optional)String (open/close)Project's Status
active (optional)Integer (1/0)Published on BF website (Yes=1 or No=0)
completed (optional)IntegerCompleted percentage (0-100)
minimum (optional)FloatMinimum investment amount
target (optional)FloatTarget amount
ini (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDStarting Date
end (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDEnding Date
finished (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDProject's Finished Funded Date
investors (optional)IntegerNumber of investors
gross (optional)FloatGross Rate Percentage
net (optional)FloatNet Rate Percentage
coc (optional)FloatCash-On-Cash Rate Percentage
disinvestment (optional)IntegerPeriod in months of disinvestment
images (optional)Array (URLs)List of images URLs.
Note: First one will be the Main Image
languages (optional)

One Object per language (ISO 639-1 Code as Key) containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

url (required)String (URL)Project's URL
intro (optional)StringProject's introduction (optional)
description (required)StringProject's description

Languages object with per language information.

Example:

                        languages: {
                          en: {
                            url: "http://www.myplatform.com/en/myproject",
                            intro: "My intro",
                            description: "My long description"
                          },
                          es: {
                            url: "http://www.myplatform.com/es/miproyecto",
                            intro: "Una introducción",
                            description: "Una descripción larga"
                          }
                        }
                      

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
(optional) errorsArray of stringsList of errors detected


Posts Information



INSERT POSTS

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/posts?apikey=Votre_clé_api_clé

REQUEST TYPE: JSON

REQUEST:

PropertyValuesDescription
name (required)String (plain text)The name/title of the post
description (required)String (plain text)A short abstract of the article
body (required)String (html)The body of the post
language (required)StringLanguage of the post (ISO 639-1)
date (required)NumberPublished Date (EPOCH milliseconds)
image (required)URL (string)Absolute URL Image
source (optional)URL (string)Absolute URL of the post on your site