API: Installing avejana’s API

This guide will take you step by step through the process of installing aveJana through API on your website.

Set up: Following elements will be required to be sent as a header with curl call for authorization purpose. All of these settings can be found in your aveJana’s dashboard -> Settings -> Extension Settings:

CompanyID

UserID

REST-AJEVANA-KEY

Below is the list of APIs which can be called at various stages. URLs used below are example URLs, actual URLs can be found in your aveJana account at Settings -> Extension Settings.

Extension Settings Page in your aveJana account

 

Postman : adding elements in header

 

Create Product API

This API will be called to create or export products from brand’s eCommerce portal to aveJana’s dashboard. This is the initial API to be called as without the creation of products in aveJana’s dashboard reviews, question & answers and sales data will not start to flow.

Type: PUT

URL: https://yoursite.avejana.com/api/product (here ‘yoursite.avejana.com’ is the URL of your account that you would have received in the email with your login details).

Data to be sent

  • CompanyID: ID provided by aveJana for your company
  • ProductID (Alpha-Numeric): Your internal productid to uniquely identify the product
  • ProductURL (URL): URL of the product page on brand’s portal
  • ProductName (Alpha-numeric): Name of the product
  • ProductDescription (Text)
  • ProductPictureURL: URL of the picture of the product on brand’s portal
  • ProductPrice (Decimal)

 

Note: In all the examples, we are using POSTMAN extension of Chrome browser to call APIs.

 

  • In the above screen, we are calling the API to create the product with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the product created in aveJana’s dashboard.

 

Product created in avejana’s Dashboard

 

 

Review Send API

This API will be called to send or export reviews from brand’s eCommerce portal to aveJana’s dashboard.

Type: PUT

URL: https://company.avejana.com/api/review (this URL is to be entered as it is. No changes to be made to this.)

Data to be sent

  • FromCompany: CompanyID provided by aveJana to your company
  • ProductID: Your internal Product ID to uniquely identify the product
  • InternalReviewID: Review ID generated by your portal to identify the review
  • UserName: Name of the user who has written the review
  • UserEmail: Email id of the user
  • Title (max length 255): Title of the review
  • Ratings (between 1 and 5): Rating given to the product by the user
  • Description: Entire description of the review written by the user.

 

Postman : Generating Review on the Product.

 

  • In the above screen, we are calling the API to create the review with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the reviews generated in aveJana’s dashboard.

 

Review on aveJana’s Dashboard.

 

 

Replies of Review API

This API will be called to export reviews reply from brand’s ecommerce portal to aveJana’s dashboard.

Type: GET

URL: https://company.avejana.com/api/reviewreply  (this URL is to be entered as it is. No changes to be made to this.)

Data to be sent

  • CompanyID: provided by aveJana to your company
  • ProductID: Your internal Product ID to uniquely identify the product

 

Postman: Fetching the Review’s reply.

 

  • In the above screen, we are calling the API to fetch the review reply with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the Review Reply in aveJana’s dashboard.

 

Review Reply on aveJana’s Dashboard

 

 

Question API

This API will be called to create or export question from brand’s ecommerce portal to aveJana’s dashboard. This API to be called when some wants to ask question regarding the products in aveJana’s dashboard .

Type: PUT

URL: https://company.avejana.com/api/question  (this URL is to be entered as it is. No changes to be made to this.)

Data to be sent

  • FromCompany: : ID provided by aveJana for your company
  • ProductID (Alpha-Numeric): Your internal product to uniquely identify the product
  • InternalQNAID: QNA ID generated by your portal to identify the question
  • UserName: Name of the user who has written the review
  • UserEmail: Email id of the user
  • Question: Entire Question for the product written by the user.

 

Postman : Creating Question on Product

 

  • In the above screen, we are calling the API to create the question with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the Qestion in aveJana’s dashboard.

 

Question in aveJana’s Dashboard

 

 

Answer to Question API

This API will be called to export answer of questions from brand’s ecommerce portal to aveJana’s dashboard.

Type: GET

URL: https://company.avejana.com/api/answer (this URL is to be entered as it is. No changes to be made to this.)

Data to be sent

  • CompanyID: provided by aveJana to your company
  • ProductID: Your internal Product ID to uniquely identify the product

 

Postman : Fetching answers from aveJana’s Dashboard

 

  • In the above screen, we are calling the API to fetch the answe with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the Answer of Question in aveJana’s dashboard.

 

 

Answer in aveJana’s Dashboard

 

 

Page views API

This API will be called to check the page views from brand’s ecommerce portal to aveJana’s dashboard.

Type: PUT

URL: https://yoursite.avejana.com/api/pageviews  (here ‘yoursite.avejana.com’ is the URL of your account that you would have received in the email with your login details).

Data to be sent

  • CompanyID: provided by aveJana to your company
  • ProductID: Your internal Product ID to uniquely identify the product
  • IP : Your system Internal Protocol Address to identify the pages views on your system.

 

Postman : Creating Pages views of the system

 

  • In the above screen, we are calling the API to check the page views with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the Page views on aveJana’s dashboard.

 

 

Total No. of page views in aveJana’s Dashboard

 

 

Sales API

This API will be called to create or export orders/sales from brand’s ecommerce portal to aveJana’s dashboard. This API to be called when some wants to generate order regarding the products in aveJana’s dashboard .

Type: PUT

URL: https://yoursite.avejana.com/api/sales  (here ‘yoursite.avejana.com’ is the URL of your account that you would have received in the email with your login details).

Data to be sent

  • OrderID: ID generated by your portal to identify the order.
  • OrderDate(Alpha-numeric) : Your system will generate the date of the order(YYYY- MM-DD)
  • CustomerName: Name of the user who has order the product.
  • CustomerEmail: Email id of the user
  • ProductID: Your internal Product ID to uniquely identify the product
  • Price(Decimal): Price of the Product
  • Quantity: Total no. of quantity of products

 

Postman : Generating Sales in aveJana’s Dashboard.

 

  • In the above screen, we are calling the API to generate the Sales with all the required data. On successful completion, API will return status as “success” otherwise it’ll return “failure”.
  • In the screen below, you can see the Sales on aveJana’s dashboard.

 

Sales Upload on aveJana Dashboard.

 

 

 

Set Review Status

When you start receiving reviews from Invitation sent through aveJana’s dashboard. aveJana will send those reviews to your ecommerce platform with  its own ReviewID. Once your save those reviews received through invitations in your store’s database, you have to send set review status by calling this API.

Type: PUT

URL: https://company.avejana.com/api/set_review_status (this URL is to be entered as it is. No changes to be made to this.)

Data to be sent

  • InternalReviewID (Review ID generated on brand’s database)
  • CompanyID : provided by aveJana to your company
  • ReviewID (aveJana systems ReviewID)

 

Thats it. Now you are ready to start using aveJana. If you face any issues in configuration then feel free to let us know by writing to us. Or visit https://avejana.com and just hit the chat button. Someone will assist you.

 

 

Leave a Comment

Start typing and press Enter to search