Oauth2
URL: https://{instance}.salesforce.com/services/oauth2/tokenM
Method: POST
Query Params:
username: XXX
password: YYY
client_id: 34M******************
client_secret: 457************
redirect_uri: https://www.getpostman.com/oauth2/callback
grant_type: password
Response:
{
"access_token": "00Df2000001Knst!AQYAQAFPCo2rlkGKhEdlicn.L_GcLl5VbVupmOhcA4hKYIa3YuNfzDuZ0qxFrgn2J00gCp3mCJFs0D3OSoWKN5GLzvWs.XB4",
"instance_url": "https://na53.salesforce.com" ,
"id": "https://login.salesforce.com/id/00Df2000001KnstEAC/005f2000008sf5iAAA",
"token_type": "Bearer",
"issued_at": "1544509938883" ,
"signature": "LBzGeX/GVE9CHLpyTR8PS6WhQsRBBkBipJMmW+MJ/Wc="
}
Error:
{
"error": "invalid_client_id",
"error_description": "client identifier invalid"
}
API to fetch data
URL: https://{instance}.salesforce.com/services/data/v20.0/sobjects/{ObjectName}
Method: GET
Sample REQUEST:
Header:
{
"Authorization": :Bearer Tl1M***************************
}
Sample RESPONSE:
Response:
"recentItems": [
{
"attributes": {
"type": ,
"url": "/services/data/v20.0/sobjects/{ObjectName}/a09f200000s55F2AAI"
},
"Id": "a09f200000s55F2AAI" ,
"Name":"HSV red"
},
{
"attributes": {
"type": " ObjectName ",
"url": "/services/data/v20.0/sobjects/ObjectName /a09f200000qNqOrAAK"
},
"Id": "a09f200000qNqOrAAK",
"Name": "Chevrolet"
}
]
Error:
{
"error": "NOT_FOUND",
"message": "The requested resource does not exist"
}
API to invalidate current session
URL: https://{instance}.salesforce.com/services/oauth2/revoke
Method: POST
Sample REQUEST:
Body:
{
"token": :00D***************************
}
Sample RESPONSE:
Response:
Empty Response (Token Revoked)
Video Link for OKTA SSO: https://www.screencast.com/t/vsG0Annjrg
Needed things:
1. For connecting the AS and SF, Client have to give the auctionsite as “redirectUrl”, ClientId, ClientSecret from the Client Salesforce account and API for fetch the products details.
Note: For authentication we are using token for api response which should be matched in both side, if the “authtoken” is matched then only we get can access the api. “authtoken” is generated by using ClientId, ClientSecret.
Products
- Auctionsoftware (AS) needs the product details of Third Party Site.
- AS fetch all products from Salesforce (SF) through Product API response.
- SF has to give the api for fetching the product details.
- AS save the products details into the db by the product api response.
- Third Party Site Admin can setup the auction with the details of Start date, End date, Starting price, Reserve Price, Bid Increment.
- For this, Third Party Site has to add the fields in DB for saving the details of Start date, End date, Starting price, Reserve Price, Bid Increment, product_status etc.
SET AUCTION API
URL: https://api.auctionsoftware.com/product/view,
https://api.auctionsoftware.com/product/view/{ObjectName},
https://api.auctionsoftware.com/product/view/{ObjectName}/{Id}
Method: POST
Header:
{
accessToken:00Df****************,
instanceUrl:https://{instance}.salesforce.com,
Content-Type: application/x-www-form-urlencoded
}
body{
'Name':1,
'date__c':'1',
'API Name of Field':1
}
Response:
{
"Status": "Success",
"result": [
{
"attributes": {
"type": "ProductDetails__c",
"url": "/services/data/v29.0/sobjects/ProductDetails__c/a09f200000svU3oAAE"
},
"Id": "a09f200000svU3oAAE",
"p_id__c": "022",
"Name": "Toyota",
"sprice__c": null,
"date__c": "2018-12-11",
"enddate__c": "2018-12-11",
"rprice__c": null,
"status__c": "open",
"WinnerId__c": null,
"Winner_Name__c": null
},
{
"attributes": {
"type": "ProductDetails__c",
"url": "/services/data/v29.0/sobjects/ProductDetails__c/a09f200000qNqOrAAK"
},
"Id": "a09f200000qNqOrAAK",
"p_id__c": "015",
"Name": "Chevrolet",
"sprice__c": 1,
"date__c": "1995-08-18",
"enddate__c": "2018-12-09",
"rprice__c": 2,
"status__c": null,
"WinnerId__c": "20",
"Winner_Name__c": "YYY"
}
]}
{
"Status": "Error",
"Message": "Invalid Object"
}
Bidding and Awarding:
- Auction is handling in AS side and it has to update the bids and the winner of the product through Bids API and Winner API.
- In AS, Third Party Site Buyers can login through SSO and Bid on the products.
- After Reserve Price met and at the End of the Time Product will be awarded to highest bidder.
- After auction closed AS will send the response to SF through bids api and winner api to update the bids details and won buyer.
- For this SF has to add fields in their product table which are Status, bids and Won_id.
INSERT BIDS API:
URL: https://api.auctionsoftware.com/bidhistory
Method: POST
Header:
{
accessToken:00Df********************************
instanceUrl:https://{instance}.salesforce.com
Content-Type:application/json
}
Body:
{
"bid_history":[{"Name":"XXX","userid":"1","wprice":"21000"},{"Name":"YYY","userid":"22","wprice":"22000"}]
}
Response:
{
"Status": "Success"
}
Error:
{
"Status": "Error",
"Message": {
"name": "INVALID_SESSION_ID",
"errorCode": "INVALID_SESSION_ID"
}
}
WINNER API:
URL: https://api.auctionsoftware.com/won/product_id
Method: PUT
Header:
{
accessToken:00Df********************************
instanceUrl:https://{instance}.salesforce.com
Content-Type: application/x-www-form-urlencoded
}
Response:
{
"Status": "Success"
}
Error:
{
"Status": "Error",
"Message": {
"name": "NOT_FOUND",
"errorCode": "NOT_FOUND"
}
}
OKTA Single Sign On
- At first create an application in OKTA for SSO integration.
- Set the OKTA authentication with “Redirect url, Destination url, ClientId, Secret Key etc.”
- Enable the SAML 2.0 Authentication and Integrate with Auction Software (AS) for SSO.
- User can sign in with AS by the use of OKTA SSO.
- From the OKTA api AS get the details of “user_id, username, email_id” to SSO.
- User_id, Name is used in bid history for the display purpose. Email_id is used for sending the email while bidding.
- When the user is log out in Third party site means then he will logged out from AS also.
OKTA SSO API
API : https://www.okta.com/products/single-sign-on/
Method: 'passport-saml'
Request:
callbackUrl: 'https://api.auctionsoftware.com/sso',
entryPoint: 'https://auc18.okta.com/app/auc1/exkebj9bCwly4inex355/sso/saml',
issuer: 'http://www.okta.com/exkebj9bCwly4inex355',
cert: fs.readFileSync('./okta.cert', 'utf-8'), // <-- cert file from okta
Response:
{
$ status : success;
$ result['auth'] = ‘authtoken’;
$ result['user_id'] = user_id;
$ result['user_name'] = 'username';
$ result['email_id'] = ‘user_email’;
}
Error:
{
$ status : false;
$error: ‘error message’;
}
Bidder login:
This API for Bidder(Buyer) login
URL : http://silentauction.drupalcustomization.com/API/index.php/client/login_bidder
Header Data to send in Request:
Header:
{
Username - Your Username
Password - Your Password
}
Response:
{
"status":0,
"result":{
"user_id":"335",
"ipaddress":"103.249.204.78",
"iprestrict":"0",
"cid":"0",
"username":"tbid",
"password":"a44c7697fb91afb6c8f66af623bb577c",
"salt":"yk.qj",
"secretquestion":"{_what_is_my_email_address}",
"secretanswer":"0bd0979697eaf6c2323c2d2b1c90c865",
"email":"manivel.auctionsoftware+53@gmail.com",
"first_name":"tbid",
"last_name":"tbid",
"childname":"tbid",
"address":"",
"address2":"test, test",
"city":"texas",
"state":"Jammu and Kashmir",
"zip_code":"",
"phone":"+918508493434",
"country":"375"
,
"date_added":"2018-07-03 08:58:56",
"subcategories":null,
"status":"active",
"serviceawards":"0",
"productawards":"16",
"servicesold":"0",
"productsold":"0",
"rating":"0",
"score":"0",
"feedback":"0",
"bidstoday":"8",
"bidsthismonth":"8",
"auctiondelists":"0",
"bidretracts":"0",
"lastseen":"2018-12-11 05:02:49",
"dob":"0000-00-00",
"rid":"NASXXC",
"account_number":"IL8823073061226",
"available_balance":"0.00",
"total_balance":"0.00",
"income_reported":"0.00",
"income_spent":"0.00",
"startpage":"main",
"styleid":"1",
"project_distance":"1",
"currency_calculation":"1",
"languageid":"1",
"currencyid":"1",
"timezone":"",
"notifyservices":"0",
"notifyproducts":"0",
"notifyservicescats":"",
"notifyproductscats":"",
"lastemailservicecats":"0000-00-00",
"lastemailproductcats":"0000-00-00",
"displayprofile":"1",
"emailnotify":"0",
"displayfinancials":"0",
"vatnumber":"",
"regnumber":"",
"dnbnumber":"",
"companyname":"",
"usecompanyname":"0",
"timeonsite":"0",
"daysonsite":"0",
"isadmin":"0",
"permissions":null,
"searchoptions":null,
"rateperhour":"0.00",
"profilevideourl":null,
"profileintro":null,
"gender":"",
"freelancing":"",
"autopayment":"1",
"posthtml":"0",
"username_history":null,
"password_lastchanged":"2018-12-11 04:56:48",
"org_name":"",
"org_email":"",
"org_web":"",
"microsite_name":"",
"trans_id":"6bbny2",
"customer_id":"test_customer_335",
"token_id":"bfhgdh",
"pricing_id":"0",
"subscription_id":"",
"donation_limit":"0",
"min_donation_limit":"0",
"addbycharity_id":"201",
"biddervisible":"1",
"roleid":"4",
"subscriptionid":"1
"active":"yes",
"cost":"0.00",
"currency_name":"US DOLLAR",
"currency_abbrev":"USD",
"languagecode":"english"
},
"message":"Success"
}
Error :
{
"status":1,
"result":"Password is incorrect",
"message":"failed"
Bidder - Dashboard
This API for Buyer Dashboard
URL : http://silentauction.drupalcustomization.com/API/index.php/client/dashboard_bidder
Header:
{
User_id : Your User ID
}
Response:
{
{
"status": 0,
"data": {
"buy": [],
"bids": [
{
"end_time": "Jan 31 2019, 12:00 PM SST",
"micrositename": "testing",
"email": "manivel.auctionsoftware@gmail.com",
"name": "test",
"charityid": "201",
"title": "test",
"url": "http://localhost/SilentAuction/trunk/testing"
}
],
"fetchuserlinks": [
{
"end_time": "Jan 31 2019, 12:00 PM SST",
"micrositename": "testing",
"email": "manivel.auctionsoftware@gmail.com",
"name": "test",
"charityid": "201",
"title": "test",
"url": "http://localhost/SilentAuction/trunk/testing"
}
],
"list": [
{
"end_time": "Jan 31 2019, 12:00 PM SST",
"micrositename": "testing",
"email": "manivel.auctionsoftware@gmail.com",
"name": "test",
"charityid": "201",
"title": "test",
"url": "http://localhost/SilentAuction/trunk/testing"
}
]
},
"result": "",
"message": "success"
}
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Bidder - Event Dashboard
This API for Event Dashboard. It has seller products
URL : http://silentauction.drupalcustomization.com/API/index.php/client/event_dashboard_bidder
Header:
{
User_id - username of bidder
Charity_id - adding charityid
Microsite_name - name of microsite
Keyword - search keyword
Page - products per page
}
Response:
{
{
{
"status": 0,
"data": {
"microsite_name": "mtest5",
"user_id": "391",
"charity_id": "212",
"title_post": "mtest5",
"description": "mtest5",
"post_list_new": [],
"post_list_total": 26,
"total_pages": 3,
"bidders_list": [
{
"maxbid": "105.00",
"user": "dbid",
"userid": "391"
}
],
"donars_list": null,
"categorylists": [
{
"id": "354",
"name": "testing",
"count": 8
},
{
"id": "select",
"name": "{_unknown}",
"count": 1
},
{
"id": "371",
"name": "sss",
"count": 5
},
{
"id": "360",
"name": "aaaaa",
"count": 18
},
{
"id": "361",
"name": "bbb",
"count": 2
}
]
},
"result": "",
"message": "success"
}
}
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Change Password
This API For Changing Buyer account Password
URL : http://silentauction.drupalcustomization.com/API/index.php/client/change_password_bidder
Header:
{
User_id - username of bidder
Old_password - previous password
New_password - new password
}
Request :
{
"status": 0,
"result": {
"user_id": "391",
"ipaddress": "::1",
"iprestrict": "0",
"cid": "0",
"username": "dbid",
"password": "521c5a81e1575d3cf5138c209dffa53e",
"salt": "^k@3g",
"secretquestion": "{_what_is_my_email_address}",
"secretanswer": "daff0754b82ccc53dc5cb0360c9cad77",
"email": "manivel.auctionsoftware+105@gmail.com",
"first_name": "dbid",
"last_name": "p",
"childname": "dbid",
"address": "",
"address2": "chrompet,developing scripts",
"city": "chennai",
"state": "Tamil Nadu",
"zip_code": "",
"phone": "+917894561230",
"country": "375",
"date_added": "2018-08-28 09:29:19",
"subcategories": null,
"status": "active
"serviceawards": "0",
"productawards": "6",
"servicesold": "0",
"productsold": "0",
"rating": "0",
"score": "0",
"feedback": "0",
"bidstoday": "6",
"bidsthismonth": "6",
"auctiondelists": "0",
"bidretracts": "0",
"lastseen": "2018-12-13 03:41:08",
"dob": "0000-00-00",
"rid": "IJDJZN",
"account_number": "IL2639558513158",
"available_balance": "0.00",
"total_balance": "0.00",
"income_reported": "0.00",
"income_spent": "0.00",
"startpage": "main",
"styleid": "1",
"project_distance": "1",
"currency_calculation": "1",
"languageid": "1",
"currencyid": "1
"timezone": "",
"notifyservices": "0",
"notifyproducts": "0",
"notifyservicescats": "",
"notifyproductscats": "",
"lastemailservicecats": "0000-00-00",
"lastemailproductcats": "0000-00-00",
"displayprofile": "1",
"emailnotify": "0",
"displayfinancials": "0",
"vatnumber": "",
"regnumber": "",
"dnbnumber": "",
"companyname": "",
"usecompanyname": "0",
"timeonsite": "0",
"daysonsite": "0",
"isadmin": "0",
"permissions": null,
"searchoptions": null,
"rateperhour": "0.00",
"profilevideourl": null,
"profileintro": null,
"gender": "",
"freelancing": "",
"autopayment": "1",
"posthtml": "0",
"username_history": null,
"password_lastchanged": "2018-10-09 08:27:39",
"org_name": "",
"org_email": "",
"org_web": "",
"microsite_name": "",
"trans_id": "876g3g",
"customer_id": "test_customer_391",
"token_id": "czwtxc",
"pricing_id": "0",
"subscription_id": "",
"donation_limit": "0",
"min_donation_limit": "0",
"addbycharity_id": "212",
"biddervisible": "1",
"user_token": "",
"token_status": "",
"saas_user_id": "0"
},
"message": "Success"
}
Error :
{
"status":1,
"result":"change password details incorrect",
"message":"failed"
Forgot Password
This API for retriving Buyer password.
URL : http://silentauction.drupalcustomization.com/API/index.php/client/forgot_password_bidder
Header:
{
Email - Email id
}
Request :
{
"status": 0,
"result": "Your account password was changed.please check mail Inbox/Spam folder",
"message": "Success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Product View
This API for Viewing bidding and buynow products
URL : http://silentauction.drupalcustomization.com/API/index.php/client/product_view_bidder
Header:
{
User_id - username of bidder
Charity_id - adding charityid
Project_id - product id
}
Response :
{
{
"status": 0,
"data": {
"endtime": "Dec 31 2018, 02:00 PM AKST",
"project_title": "ttt",
"filtered_auctiontype": "regular",
"product_image_small": "uploads/attachments/auctions/resized/mini/0ecf501d53a9fdb67da11f59eb8a23f4.attach",
"product_image": "uploads/attachments/auctions/original/0ecf501d53a9fdb67da11f59eb8a23f4.attach",
"thumbimages": [
{
"imagess": "http://localhost/SilentAuction/trunk/uploads/attachments/auctions/resized/mini/0ecf501d53a9fdb67da11f59eb8a23f4.attach",
"product_image_large": "http://localhost/SilentAuction/trunk/uploads/attachments/auctions/original/0ecf501d53a9fdb67da11f59eb8a23f4.attach"
}
],
"imagess": null,
"product_image_large": null,
"bidtype": "silent",
"startdate": "2018-08-27 13:15:00-08:00",
"enddate": "2018-12-31 14:00:00-09:00",
"datenow": "2018-12-12 23:58:55-09:00",
"timezone": "AKST",
"auctiontype": "fixed",
"cid": "354",
"minimum_bid": "US$0.00",
"current_bid": "US$0.00",
"reserve_price": "US$0.00",
"estimated_price": "US$210.00",
"bids": "0",
"bid_increment": "US$0.00",
"ended": null,
"product_type": "digital",
"shipping_charges": null,
"donor_name": "test",
"project_status": "open",
"buynow_price": "US$200.00",
"project_id": "75365120",
"project_user_id": 388,
"charity_id": "212",
"quantity": 6,
"buynow_quantity": 4,
"available": "4 left / 2 sold",
"description": "tyh",
"categorylists": [
{
"id": "354",
"name": "testing"
},
{
"id": "select",
"name": "{_unknown}"
},
{
"id": "371",
"name": "sss"
},
{
"id": "360",
"name": "aaaaa"
},
{
"id": "361",
"name": "bbb"
}
],
"messages": null,
"pictures": [
{
"id": "702",
"project_id": "75365120",
"escrow_id": "0",
"cid": "354",
"description": "tyh",
"ishtml": "0",
"description_videourl": "",
"date_added": "2018-08-27 06:19:08",
"date_starts": "2018-08-27 13:15:00",
"date_end": "2018-12-31 14:00:00",
"gtc": "0",
"gtc_cancelled": "0000-00-00 00:00:00",
"user_id": "388",
"visible": "1",
"views": "7",
"project_title": "ttt",
"bids": "0",
"bidsdeclined": "0",
"bidsretracted": "0",
"bidsshortlisted": "0",
"budgetgroup": "",
"additional_info": null,
"status": "open",
"close_date": "0000-00-00 00:00:00",
"transfertype": "userid",
"transfer_to_userid": "0",
"transfer_from_userid": "0",
"transfer_to_email": "",
"transfer_status": "",
"transfer_code": "",
"project_details": "",
"project_type": "forward",
"project_state": "product",
"bid_details": "open",
"filter_rating": "0",
"filter_country": "0",
"filter_state": "0",
"filter_city": "0",
"filter_zip": "0",
"filter_underage": "0",
"filter_businessnumber": "0",
"filter_bidtype": "0",
"filter_budget": "0",
"filter_escrow": "0",
"filter_gateway": "0",
"filter_ccgateway": "0",
"filter_offline": "0",
"filter_publicboard": "0",
"filtered_rating": "",
"filtered_country": "",
"filtered_state": "",
"filtered_city": "",
"filtered_zip": "",
"filter_bidlimit": "0",
"filtered_bidlimit": "10",
"filtered_bidtype": "entire",
"filtered_bidtypecustom": "",
"filtered_budgetid": "0",
"filtered_auctiontype": "fixed",
"classified_phone": "",
"classified_price": "0.00",
"urgent": "0",
"buynow": "1",
"buynow_price": "200.00",
"buynow_qty": "4",
"buynow_qty_lot": "6
"items_in_lot": "1",
"buynow_purchases": "2",
"reserve": "0",
"reserve_price": "0.00",
"featured": "1",
"featured_date": "0000-00-00 00:00:00",
"featured_searchresults": "0",
"highlite": "0",
"bold": "0",
"autorelist": "0",
"autorelist_date": "0000-00-00 00:00:00",
"startprice": "0.00",
"paymethod": "a:0:{}",
"paymethodcc": "a:0:{}",
"paymethodoptions": "a:1:{s:9:\"braintree\";s:1:\"1\";}",
"paymethodoptionsemail": "a:0:{}",
"keywords": "",
"currentprice": "0.00",
"insertionfee": "0.00",
"enhancementfee": "2.75",
"fvf": "0.00",
"isfvfpaid": "0",
"isifpaid": "0",
"isenhancementfeepaid": "0",
"ifinvoiceid": "0",
"enhancementfeeinvoiceid": "934",
"fvfinvoiceid": "0",
"returnaccepted": "0",
"returnwithin": "0",
"returngivenas": "none",
"returnshippaidby": "none",
"returnpolicy": "",
"buyerfeedback": "0",
"sellerfeedback": "0",
"hasimage": "0",
"hasimageslideshow": "0",
"hasdigitalfile": "0",
"haswinner": "0",
"hasbuynowwinner": "1",
"winner_user_id": "0",
"donation": "0",
"charityid": "212",
"donationpercentage": "0",
"donermarkedaspaid": "0",
"donermarkedaspaiddate": "0000-00-00 00:00:00",
"donationinvoiceid": "0",
"currencyid": "1",
"countryid": "375",
"country": "India",
"state": "Jharkhand",
"city": "Texas",
"zipcode": "",
"sku": "",
"upc": "",
"ean": "",
"isbn10": "",
"isbn13": "",
"partnumber": "",
"modelnumber": "",
"salestaxstate": "",
"salestaxrate": "0",
"salestaxentirecountry": "0",
"salestaxshipping": "0",
"countdownresets": "0",
"bulkid": "0",
"updateid": "0",
"bid_increment": "",
"number": "0",
"min_bid": "",
"estimate": "210",
"donar_name": "test",
"donar_web": "google.com",
"bidtype": "silent",
"title_donation": "",
"categories": "354",
"product_type": "digital",
"shipping_charges": "0",
"saas_product_id": "0",
"saas_store_id": "0",
"mytime": "1605665",
"ship_method": "flatrate",
"starttime": "9283435",
"imgsrc": "http://localhost/SilentAuction/trunk/attachment.php?cmd=thumb&subcmd=itemphoto&id=0ecf501d53a9fdb67da11f59eb8a23f4&w=1024&h=768",
"imgsrc_original": "http://localhost/SilentAuction/trunk/attachment.php?cmd=thumb&subcmd=itemphoto&original=1&id=0ecf501d53a9fdb67da11f59eb8a23f4&w=0&h=0",
"img": ""
}
],
"thumbnails": [
{
"attachid": "1016",
"attachtype": "project",
"user_id": "388",
"portfolio_id": "0",
"project_id": "75365120",
"pmb_id": "0",
"category_id": "0",
"date": "2018-08-27 06:19:06",
"filename": "236(1).jpg",
"filetype": "",
"visible": "1",
"counter": "0",
"filesize": "0",
"filehash": "0ecf501d53a9fdb67da11f59eb8a23f4",
"ipaddress": "",
"tblfolder_ref": "0",
"width_full": "1024",
"height_full": "768",
"width_mini": "60",
"height_mini": "60",
"width_original": "0",
"height_original": "0",
"img": "",
"tab": 1
}
],
"thumbnails_modal": [
{
"attachid": "1016",
"attachtype": "project",
"user_id": "388",
"portfolio_id": "0",
"project_id": "75365120",
"pmb_id": "0",
"category_id": "0",
"date": "2018-08-27 06:19:06",
"filename": "236(1).jpg",
"filetype": "",
"visible": "1",
"counter": "0",
"filesize": "0",
"filehash": "0ecf501d53a9fdb67da11f59eb8a23f4",
"ipaddress": "",
"tblfolder_ref": "0",
"width_full": "1024",
"height_full": "768",
"width_mini": "60",
"height_mini": "60",
"width_original": "0",
"height_original": "0",
"img": "",
"tab": 1
}
],
"state": "product",
"minimum": "0.00",
"highbidnotify": 1,
"lasthournotify": 0,
"subscribed": 1,
"shipperid": 0,
"username": "dbid",
"isproxy": "1",
"reserve": "1",
"reserve_met": "1"
},
"result": "",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Buy now Confirm
This API For Buy Now Confirm
URL : http://silentauction.drupalcustomization.com/API/index.php/client/buy_now_confirm_bidder
Header:
{
User_id - username of bidder
Charity_id - adding charityid
Project_id - product id
Quantity - required quantity
}
Response :
{
"status": 0,
"data": {
"user_id": "391",
"project_title": "ttt",
"project_id": "75365120",
"charity_id": "212",
"quantity": 2,
"price": "US$200.00",
"shipping_price": "US$0.00",
"total_amount": "US$400.00",
"image": "uploads/attachments/auctions/resized/search/0ecf501d53a9fdb67da11f59eb8a23f4.attach",
"encrypted": "YToxMzp7czozOczoxOiIxIjtzOjQ6ImNoaWQiO3M6MzoiMjEyIjt9"
},
"result": "",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Buy now
This API for initiating Buy Now
URL : http://silentauction.drupalcustomization.com/API/index.php/client/buy_now_bidder
Header:
{
User_id - username of bidder
Charity_id - adding charityid
Project_id - product id
Encrypted -
}
Response :
{
"status": 0,
"data": "You have successfully confirmed the purchase of this item. We have dispatched you an email with further information. To contact this seller please visit your buying activity menu to launch private message board and feedback controls.\r\n
Please remember to leave feedback once your transaction is complete.",
"result": "",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Place Bid Confirm
This API for confirmation the bidding
URL : http://silentauction.drupalcustomization.com/API/index.php/client/place_bid_confirm_bidder
Header:
{
User_id - username of bidder
Charity_id - adding charityid
Project_id - product id
State -
Minimum-
Isproxy-
Reserve
Buynow
buynowprice
Bidamount - Your Bidding Amount
qty
}
Response :
{
"status": 0,
"data": {
"user_id": "391",
"project_id": "15284860",
"charity_id": "212",
"bidamount": "40",
"project_user_id": "388",
"highbidnotify": 1,
"lasthournotify": 0,
"subscribed": 1,
"bidstate": "",
"state": "product",
"minimum": "27.00",
"bid_amount": "US$40.00",
"reserve_met": "{_yes_reserve_price_met}",
"qty": "5",
"shipperid": 0
},
"result": "",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Place Bid
This API for Placing the bid.
URL : http://silentauction.drupalcustomization.com/API/index.php/client/place_bid_bidder
Header:
{
User_id - Username
Project_user_id -
Charity_id - adding charity id
Project_id - project id
Highbidnotify -
Lasthournotify -
Subscribed -
Bidstate -
State -
Minimum -
Bid_amount -
Reserve_met -
Shipperid -
Bidamount -
Qty -
}
Response :
{
"status": 0,
"data": "You have successfully bidded",
"result": "",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Donation Page
This API for Donation page
URL : http://silentauction.drupalcustomization.com/API/index.php/client/make_a_donation_page_data
Header:
{
User_id : username of bidder
Charity_id : adding charity id
}
Response :
{
"status": 0,
"data": {
"user_id": "391",
"charity_id": "212",
"amountlimit": 100000,
"min_donation_limit": 5,
"countryid": "500"
},
"result": "",
"message": "success"
}
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Make a Donation
This API for Make a Donation
URL : http://silentauction.drupalcustomization.com/API/index.php/client/make_a_donation
Header:
{
User_id - Username
Charity_id - addming charity id
Amountlimit - max amount limit
Minamountlimit - minimum limit amount
Amount - amount
Comments
Credit_card_number - Your Credit card number
Cvv - Your credit card cvv
Expmonth - Credit card Expiration Month
Expyear - Credit card Expiration Year
First_name - Your First name
Last_name - Your Last name
Address - Your Address
Address2 - Your Secondary Address
Country - Your Country
State- Your State
City - Your Coty
Zipcode - Your Zipcode
Email - Your Email
Phone - Your Phone
}
Response :
{
"status": 0,
"data": "Payment method token valid.Plan ID is valid.",
"result": "",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Bidder Registration
This API for Registering the Bidder(Buyer).
URL : http://silentauction.drupalcustomization.com/API/index.php/client/register_bidder
Header:
{
Firstname
Lastname
childname
Username
Email
Address
Address2
Country
State
City
Phone
Password
Emailnotify
charityid(optional)
}
Response :
{
"status": 0,
"result": {
"roleid": 4,
"chid": 212,
"charid": 212,
"charityid": 212,
"username": "testaaa",
"childname": "",
"password": "737cd9773ef4e50ef66ec9338614cdc5",
"secretquestion": "{_what_is_my_email_address}",
"secretanswer": "345ab767a42e36f35ea1ddbf89aa8c4a",
"email": "testaaa+12@gmail.com",
"firstname": "manivel",
"lastname": "p",
"address": "testaaa",
"address2": "testaaa",
"city": "chennai",
"state": "tamilnadu",
"countryid": "375",
"cid": 0,
"emailnotify": "1",
"datestarts": "",
"datesel": "",
"datesend": "",
"phone": "123456789",
"styleid": "1",
"slng": "eng",
"languageid": 1,
"estimate": "",
"org_name": "",
"org_web": "",
"skipsessions": 0,
"bidcharity": "",
"salt": "+$?#i",
"dob": "0000-00-00",
"status": "unverified",
"biddervisible": "0",
"ipaddress": "127.0.0.1",
"country": "Canada",
"ridcode": "PYZDDP",
"gender": "",
"browseragent": "unknown",
"languagecode": "english",
"userid": 507
},
"message": "success"
}
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Bidder Profile
This API for Viewing the Bidder Profile
URL :
http://silentauction.drupalcustomization.com/API/index.php/client/bidder_profile
Header:
{
User_id - username
}
Response :
{
"status": 0,
"data": {
"user_id": "391",
"charity_id": "212",
"basic_data": {
"username": "dbid",
"phone": "+917894561230",
"first_name": "dbid",
"last_name": "p",
"childname": "dbid",
"email": "manivel.auctionsoftware+105@gmail.com",
"address": "",
"address2": "chrompet,developing scripts",
"city": "chennai",
"state": "Tamil Nadu",
"zip_code": "",
"country": "375",
"addbycharity_id": "212"
},
"category_list": [
{
"id": "354",
"name": "testing"
},
{
"id": "select",
"name": "{_unknown}"
},
{
"id": "371",
"name": "sss"
},
{
"id": "360",
"name": "aaaaa"
},
{
"id": "361",
"name": "bbb"
}
]
},
"result": "",
"message": "success"
}
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"
Bidder Profile Update
This API for Updating the Bidder(Buyer) Details.
URL :
http://silentauction.drupalcustomization.com/API/index.php/client/bidder_profile_update
Header:
{
User_id
Username
Phone
First_name
Last_name
Childname
Email
Address
Address2
City
State
Zip_code
country
}
Response :
{
"status": 0,
"data": "",
"result": "Your Bidder Profile was updated Successfully",
"message": "success"
}
Error :
{
"status":1,
"result":"Invalid Parameters",
"message":"failed"