Bric API - Easy business card data integration

Pass Images of business cards and get data in Json format



Bric API is a useful tool for developers who would like to provide a business card scanning feature in their software to integrate data from business cards.

Business card images can be captured / uploaded from your software and passed calling the Bric API, which will receive the images, transcribe it accurately through real people and send back data in Json format.


Ideal for CRM, ERP or in-house custom software...

Register

Try 15 cards for free
Show Password

Bric APP Business card scanner APP

Get Started

Getting Authorization Code

1. Register your email id with BRICAPP.

2. After successful registration with BRICAPP you can use authorization method to get authorization code.

3. You can use this authorization code when making REST calls to the API.

Authorization Method

1. Purpose

You can use the Authorization method to get authcode.
Important: Use the POST method to pass the parameters

2. Request Parameters

I. EmailID - Your Bricapp Registered Email ID
II. Password - Your Bricapp Registered Password

3. Request URL

Https Request
https://bricce.bricapp.com/v2/index.php/beta/me/authorization

4. Response

a. If successful, this method returns a Success response Status and data object in the response body.

b. If failure, this method returns a Failure response Status and respective error message.

5. Example

a. Request

    i. Post Method
     https://bricce.bricapp.com/v2/index.php/beta/me/authorization?EmailID=YourEmailID&Password=YourPassword

    ii. Body Parameters
    Do not supply a request body for this method

b. Response.

Upload Method

1. Purpose

You can use the upload method to push images into BRICAPP for transcription.
Important: Use the POST method to pass the parameters

2. Request Parameters

I. EmailID - Your Email ID
II. AuthCode - Your Authorization Code

3. Request URL

Https Request
https://bricce.bricapp.com/v2/index.php/beta/me/upload

4. Request Body

Pass Images In The Body As Multipart Data
    I. Front Image Field Name
     FrontImage
    II. Back Image Field Name (Optional)
     BackImage

5. Response

a. If successful, this method returns a Success response Status and data object in the response body.

b. If failure, this method returns a Failure response Status and respective error message.

6. Example

a. Request

    i. Post Method
     https://bricce.bricapp.com/v2/index.php/beta/me/upload?EmailID=YourEmailID&AuthCode=YourAuthorizationCode

    ii. Body Parameters
    FrontImage =frontimage.jpeg
    BackImage =backimage.jpeg

b. Response.

Download Method

1. Purpose

You can use the download method to get contacts by TempContactID.

TempContactID : Unique Record ID
In upload methods response you will get this ID to identify your record

If cards already transcribed - in response it will return contact data if its pending It will return pending contact data.

Important: Use the POST method to pass the parameters

2. Request Parameters

I. EmailID - Your Email ID
II. AuthCode - Your Authorization Code
III. TempContactID – Respective records TempContactID

3. Request URL

Https Request
https://bricce.bricapp.com/v2/index.php/beta/me/download

4. Response

a. If successful, this method returns a Success response Status and data object in the response body.

b. If failure, this method returns a Failure response Status and respective error message.

5. Example

a. Request

    i. Post Method
     https://bricce.bricapp.com/v2/index.php/beta/me/download?EmailID=YourEmailID&AuthCode=YourAuthorizationCode&TempContactID=RespectiveCardsTempContactID

    ii. Body Parameters
    Do not supply a request body for this method

b. Response.

I. Transcribed Cards Success Response
If uploaded card already transcribed. In response you will get transcribed cards Data


Note : Empty ("") field denotes the field has empty value or card does not have that data.





II. Pending Cards Success Response




III. Rejected Card Success Response


RecordStatus '1' : Transcribed and ready to download.

RecordStatus '2' : In process and available shortly.

RecordStatus '3' : Rejected .

Comment : Reason for card being rejected.

Contacts Method

1. Purpose

You can use the contacts method to get all transcribed cards.
Important: Use the POST method to pass the parameters

2. Request Parameters

I. EmailID - Your Bricapp Registred Email ID
II. AuthCode - Your Authorization Code

3. Request URL

Https Request
https://bricce.bricapp.com/v2/index.php/beta/me/contacts

4. Response

a. If successful, this method returns a Success response Status and data object in the response body.

b. If failure, this method returns a Failure response Status and respective error message.

5. Example

a. Request

    i. Post Method
     https://bricce.bricapp.com/v2/index.php/beta/me/contacts?EmailID=YourEmailID&AuthCode=YourAuthorizationCode

    ii. Body Parameters
    Do not supply a request body for this method

b. Response.

Pending Method

1. Purpose

You can use the Pending method to get all the pending cards and rejected cards detail.
Important: Use the POST method to pass the parameters

2. Request Parameters

I. EmailID - Your Bricapp Registred Email ID
II. AuthCode - Your Authorization Code

3. Request URL

Https Request
https://bricce.bricapp.com/v2/index.php/beta/me/pending

4. Response

a. If successful, this method returns a Success response Status and data object in the response body.

b. If failure, this method returns a Failure response Status and respective error message.

5. Example

a. Request

    i. Post Method
     https://bricce.bricapp.com/v2/index.php/beta/me/pending?EmailID=YourEmailID&AuthCode=YourAuthorizationCode

    ii. Body Parameters
    Do not supply a request body for this method

b. Response.

Delete Method

1. Purpose

You can use the Delete method to delete contacts by TempContactID.
Important: Use the POST method to pass the parameters

2. Request Parameters

I. EmailID - Your Bricapp registred email ID.
II. AuthCode - Your authorization code.
III. TempContactID - Respective records TempContactID.

3. Request URL

Https Request
https://bricce.bricapp.com/v2/index.php/beta/me/delete

4. Response

a. If successful, this method returns a Success response Status and data object in the response body.

b. If failure, this method returns a Failure response Status and respective error message.

5. Example

a. Request

    i. Post Method
     https://bricce.bricapp.com/v2/index.php/beta/me/delete?EmailID=YourEmailID&AuthCode=YourAuthorizationCode&TempContactID=RespectiveCardsTempContactID

    ii. Body Parameters
    Do not supply a request body for this method

b. Response.

Pricing


Card Packs


3000 cards $ 360

5000 cards $ 500

10000 cards $ 800


One time set up fee : $ 50
Register