Platform Manager v1.1 Documentación

Icon API

Una vez que haya registrado su Plataforma en BrickFunding con el Plan Freemium, podrá conectar su sitio de crowdfunding con nuestra API de forma gratuita y publicar sus oportunidades de inversión en nuestro sitio.

Para ello, simplemente inyecta la información sobre sus proyectos, siguiendo las instrucciones a continuación, y empiece a recibir inversores sin coste alguno. Revise todos los datos para asegurar la máxima precisión y conseguir que nuestros inversores le elijan para invertir. Y, si lo deseas, también puedes inyectar la información de tu blog y cada vez que publiques un nuevo artículo lo comunicaremos a nuestros usuarios. Obtenga leads de calidad para su sitio web de forma gratuita conectándose a nuestra API!

Si no dispones de un equipo técnico y necesita que desarrollemos su propia API, o necesita ayuda para implementar la integración, póngase en contacto con nosotros y le haremos un presupuesto. Conéctese con nuestra API o dénos acceso a la suya y nosotros nos encargaremos de la integración.

Beneficios de usar nuestra API

  • Podrás publicar tus proyectos: para garantizar la calidad de los datos que mostramos, no aceptamos la publicación manual de proyectos, sólo publicamos los proyectos que se inyectan de forma automatizada a través de nuestra API. Y nuestros inversores valoran mucho más las plataformas que muestran la información de sus proyectos. Así que, aunque con tu Plan Freemium sólo puedes tener tu Tarjeta de Plataforma y utilizar nuestra API, te recomendamos encarecidamente que inyectes tu información y publiques tus proyectos en brickFunding!
  • Obtendrás más tráfico: el tráfico al que nos referimos aumenta hasta un 300%. Las plataformas que listan sus proyectos y artículos con nosotros vía API reciben hasta tres veces más visitas que aquellas que sólo listan su archivo de plataforma.
  • Estarás mejor posicionado en nuestros listados: el tráfico al que nos referimos aumenta hasta un 300%. Las plataformas que listan sus proyectos y artículos con nosotros vía API reciben hasta tres veces más visitas que aquellas que sólo listan su archivo de plataforma.
  • Podrás publicar tus artículos: cada vez que publiques un nuevo artículo en tu blog, también puedes inyectarnos la información básica del mismo y aparecerá un enlace a él en tu Archivo de Plataforma y en nuestra sección de noticias. Los inversores interesados serán redirigidos a su sitio web para su lectura.
  • Aparecerá en nuestro Newsletter: semanalmente enviamos a nuestros usuarios un boletín con los últimos proyectos de inversión y artículos que han sido inyectados en nuestra API. Acceda fácilmente a miles de inversores potenciales.
  • Es gratis: esto es lo mejor de todo, si usted registra su plataforma con nosotros e integra su información a través de nuestra API puede obtener todo esto gratis!
Imagen de BrickFunding

Si requieres mayor información favor de contactarnos [email protected]

Platform Information

GET PLATFORM





METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/platform?apikey=Tu_api_key

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=Tu_api_key

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=Tu_api_key

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=Tu_api_key

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=Tu_api_key

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=Tu_api_key

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=Tu_api_key

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