Event & Registration API Documentation

Event & Registration API : Take explara event creation process, your own event listings and attendee data to your home!

To access Explara API you need access token.

NOTE :All requests with OAuth2 tokens must be made over SSL. Additional request headers are required when using access_tokens to use Explara API: “Authorization: Bearer YOUR_ACCESS_TOKEN_HERE“.

1. Create Event
Require Fields
ParameterDescription
eventType public/private
type ticketing/conference/charity/rsvp
eventTitle Event Name
url preferred event URL starting with http://www.explara.com/e/
subdomain(Optional) event subdomain [yoursubdomain.explara.com]
category business/technology/entertainment/sports/workshop/fundraising/institutions/art/parties/food/family/travel/tradeshow/movies/clubs/festivals/music/religion/comedy/community/kids/newyear/other
startDate yyyy-mm-dd
startTime HH:MM
endDate yyyy-mm-dd
endTime HH:MM
aboutEvent Event Details
listingImageListing Image URL
headerImage Header Image URL
contactInfo Organizer contact information
country (optional)Location country
state (optional)Location state
city (optional)Location city
postal (optional)Location postal code/zipcode
address (optional)Location address
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/create
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode"","eventId": ""}
OR
{"status":"success","message":"S001","eventId":"EKDJHH"}
Note: Please refer errorCode and successCode.
2. Update Event
Require Fields
ParameterDescription
eventId Event Id
eventType public/private
type ticketing/conference/charity/rsvp
eventTitle Event Name
url preferred event URL starting with http://www.explara.com/e/
subdomain(Optional) event subdomain [yoursubdomain.explara.com]
category business/technology/entertainment/sports/workshop/fundraising/institutions/art/parties/food/family/travel/tradeshow/movies/clubs/festivals/music/religion/comedy/community/kids/newyear/other
startDate yyyy-mm-dd
startTime HH:MM
endDate yyyy-mm-dd
endTime HH:MM
aboutEvent Event Details
listingImageListing Image URL
headerImage Header Image URL
contactInfo Organizer contact information
country (optional)Location country
state (optional)Location state
city (optional)Location city
postal (optional)Location postal code/zipcode
address (optional)Location address
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/update
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode""}
OR
{"status":"success","message":"S002","eventId":"EKDJHH"}
Note: Please refer errorCode and successCode.
3. Add Ticket/Registration
Require Fields
ParameterDescription
eventIdEvent Id
ticketName Name of the ticket/registration
ticketDescription (optional)Ticket/Registration description
price price (Enter 0 for Free, Leave blank for any amount)
currency INR/USD
quantity Ticket/Registration Quantity
status active/delete
startDate (optional) yyyy-mm-dd (default : todays date)
startTime (optional) HH:MM (current time)
endDate (optional)yyyy-mm-dd (default : event end date)
endTime (optional) HH:MM (default : event end time)
minQuantity (optional) Minimum purchase quantity ( default :1)
maxQuantity (optional) Maximum purchase quantity (default : 10)
serviceFee 1/2/3
[1: Absorb the fees into the ticket price, 2: Absorb gateway fee and pass on Explara fee to the buyer, 3: Pass on the fees to the buyer)
allowCancellation true/false
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/add-ticket
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode"","ticketId": ""}
OR
{"status":"success","message":"S003","ticketId":"TKCIGJ"}
Note: Please refer errorCode and successCode.
4. Update Ticket/ Registration
Require Fields
ParameterDescription
eventIdEvent Id
ticketId Ticket/ Registration Id
ticketName Name of the ticket/registration
ticketDescription (optional)Ticket/Registration description
price price (Enter 0 for Free, Leave blank for any amount)
currency INR/USD
quantity Ticket/Registration Quantity
status published/pause/cancel
startDate (optional) yyyy-mm-dd (default : todays date)
startTime (optional) HH:MM (current time)
endDate (optional)yyyy-mm-dd (default : event end date)
endTime (optional) HH:MM (default : event end time)
minQuantity (optional) Minimum purchase quantity ( default :1)
maxQuantity (optional) Maximum purchase quantity (default : 10)
serviceFee 1/2/3
[1: Absorb the fees into the ticket price, 2: Absorb gateway fee and pass on Explara fee to the buyer, 3: Pass on the fees to the buyer)
allowCancellation true/false
shippingCharge 20 (optional)
shippingChargeType INR / percentage (optional)
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/update-ticket
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode"","ticketId": ""}
OR
{"status":"success","message":"S003","ticketId":"TKCIGJ"}
Note: Please refer errorCode and successCode.
5. Add Discount
Require Fields
ParameterDescription
eventId Event Id
ticketId Ticket/ Registration Id
discountName (optional) Discount Name
discountCategory flat/bulk/code
discount Discount (Numeric)
discountType fixed/percentage
startDate (optional)yyyy-mm-dd (default : todays date)
startTime (optional) HH:MM (current time)
endDate (optional) yyyy-mm-dd (default : event end date)
endTime (optional) HH:MM (default : event end time)
limit (optional) Discount limit ( default : ticket quantity)
fromQuantity (Needed for bulk discount only ) From Quantity
toQuantity ( Needed for bulk discount only ) To Quantity
code ( Needed for code discount only) Discount Code
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/add-discount
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode"","discountId": ""}
OR
{"status":"success","message":"S003","discountId":"DKFJ"}
Note: Please refer errorCode and successCode.
6. Update Discount
Require Fields
ParameterDescription
eventId Event Id
discountName (optional) Discount Name
discountId Discount Id
discountCategory flat/bulk/code
discount Discount (Numeric)
discountType fixed/percentage
startDate (optional)yyyy-mm-dd (default : todays date)
startTime (optional) HH:MM (current time)
endDate (optional) yyyy-mm-dd (default : event end date)
endTime (optional) HH:MM (default : event end time)
limit (optional) Discount limit ( default : ticket quantity)
fromQuantity (Needed for bulk discount only ) From Quantity
toQuantity ( Needed for bulk discount only ) To Quantity
code ( Needed for code discount only) Discount Code
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/update-discount
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode"","discountId": ""}
OR
{"status":"success","message":"S003","discountId":"DKFJ"}
Note: Please refer errorCode and successCode.
7. Get Event
Require Fields
ParameterDescription
eventId Event Id
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/get-event
Request TypePOST
Response Typejson
Response {"status":"success","event":{"id":4368,"name":"My Demo Event New 2233 4444 update","url":"startup-conference-3333-indfdsi-asfds-update","extUrl":null,"description":"This is the descrption of the event.","startDate":{"date":"2014-06-27 09:00:00.000000","timezone_type":3,"timezone":"Asia\/Calcutta"},"endDate":{"date":"2014-06-29 16:00:00.000000","timezone_type":3,"timezone":"Asia\/Calcutta"},"publishedDate":{"date":"2014-12-22 15:56:42.000000","timezone_type":3,"timezone":"Asia\/Calcutta"},"eventCategory":"business","eventSubcategory":null,"attendeeRegistration":null,"eventStatus":"published","eventType":"ticketing","visiblity":true,"ticketSpecificAttendee":null,"isFree":null,"showAttendee":null,"commentsEnabled":null,"showTimer":null,"contactOrganizer":null,"contactInfo":"debasish.panda@signure.com","pricingModel":"base","processingFee":null,"agreedPricePerTicket":15,"agreedTransactionFee":3.98,"paypalFee":null,"gatewayFee":null,"explaraFee":null,"offlineExplaraFee":null,"codLimit":null,"codFlat":null,"codPercentage":null,"clientCodPercentage":null,"clientCodFlat":null,"serviceFee":null,"chequePaymentFee":1.99,"venuePaymentFee":0,"bankDepositFee":1.99,"chequePaymentFeeFlat":null,"venuePaymentFeeFlat":null,"bankDepositFeeFlat":null,"additionalCharges":null,"cancellationCharge":null,"additionalChargesComment":null,"codOn":null,"additionalInfo":null,"customTicketMessge":null,"isEventListed":null,"isaddedfeatured":null,"showContact":null,"checkoutTime":null,"customMessage":null,"message":null,"ticketMessage":null,"metaTags":null,"tags":null,"images":null,"owner":null,"coOwner":null,"featuredImage":null,"listingImage":"http:\/\/images2.fanpop.com\/image\/photos\/13900000\/The-Rose-of-Love-roses-13967150-1024-768-1.jpg","searchImage":"http:\/\/images2.fanpop.com\/image\/photos\/13900000\/The-Rose-of-Love-roses-13967150-1024-768-1.jpg","colorcode":null,"subscribecolorcode":null,"analyticsId":null,"region":null,"country":null,"freeService":null,"subdomain":null,"facebookId":null,"accountId":"11111","auditCreated":{"date":"2014-12-22 15:56:42.000000","timezone_type":3,"timezone":"Asia\/Calcutta"}}}
Note: Please refer errorCode and successCode.
8. Get Tickets
Require Fields
ParameterDescription
eventId Event Id
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/get-tickets
Request TypePOST
Response Typejson
Response {"status":"success","tickets":[{"id":4156,"typeName":"some updated","typeDesc":"Your Gate Pass updated","price":150,"includeFee":0,"quantity":50,"initialQuantity":50,"soldQuantity":null,"offlineQuantity":null,"availableFrom":{"date":"2014-12-22 19:19:57.000000","timezone_type":3,"timezone":"Asia\/Calcutta"},"availableTo":{"date":"2014-06-29 16:00:00.000000","timezone_type":3,"timezone":"Asia\/Calcutta"},"maxQuantity":10,"minQuantity":1,"ticketOrder":null,"isDiscountAvailable":null,"bibNo":null,"bibCount":null,"cummalativeDiscount":null,"refundEndDate":null,"refundAmount":null,"allowCancel":false,"status":"published","currency":"INR","shippingCharge":null,"nasscomMember":null,"nonNasscomMember":null,"shippingType":null,"eventId":"4368","ticketId":null,"eventSessionId":null}]}
Note: Please refer errorCode and successCode.
9. Get Event List
Require Fields
ParameterDescription
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/get-all-events
Request TypePOST
Response Typejson
Response {"status":error,"message":"errorCode","eventId": ""}
OR
{"status":"success","events":["":{"eventId":"EKDJHH","eventType":"public","type":"ticketing","eventTitle ":"My Demo Event","url":"http://www.explara.com/e/url-my-demo-4","subdomain":"demosubdomain4","category":"business","startDate":"30 Dec 2013","endDate":"31 Dec 2013","startTime":"09:00","endTime":"16:00","aboutEvent":"This is the descrption of the event.","listingImage":"http:\/\/images2.fanpop.com\/image\/photos\/13900000\/The-Rose-of-Love-roses-13967150-1024-768.jpg","headerImage":null,"contactInfo":"pankaj@explara.com","createdOn":"26 Nov 2013","country":"India","state":"Karnataka","city":"Bangalore","pincode":"560071","address":"Domlur layout","status":"published"}]}
Note: Please refer errorCode and successCode.
10. Get Event Report
Require Fields
ParameterDescription
eventIdEvent Id
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/get-report
Request TypePOST
Response Typejson
Response {"status":"success","amount":8709.41,"sold":159,"cancel":18,"tickets":[{"ticketId":"TKBEFH","ticketName":"VVIP ","tickets":"903","sold":3,"cancel":0},{"ticketId":"TKCIEH","ticketName":"isko free","tickets":"34","sold":0,"cancel":0}]}
Note: Please refer errorCode and successCode.
11. Event Attendee List (Use Admin account's access token to use this API)
( We are allowing maximum 50 attendee records at a time. Ex- If you want to fetch next 50 attendee records, then you have to set parameter as fromRecord - 51 and toRecord - 100)
Require Fields
ParameterDescription
eventIdEvent Id
fromRecord 0
toRecord 50
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/attendee-list
Request TypePOST
Response Typejson
Response {"status":"error","message":"errorCode"}
OR
{"status":"error","orders":"array()","attendee"=>"array()"}
{"status":"success","attendee":[{"orderNo":"E4CACBXXXXX528384A20C930",
"orderCost":"127.19","quantity":"2","status":"success","paidBy":"online","paidTo":null,
"refundAmount":null,"purchaseDate":"2013-11-13","name":"PankajKumar",
"email":"dummy@mydummydomain.com","city":"Pune","state":"Maharashtra",
"country":"India","address":"address","zipcode":"411027","phoneNo":"22222",
"attendee":{"ticketName":"Free Visit","ticketId":"TKEFAJC","name":"Pankaj Kumar",
"email":"dummy@mydummydomain.com","checkin":"no","ticketNo":"E4CACB-694",
"status":"attending","details":{"Date":""}}},
{"orderNo":"E4CACBXXXXX5278C30F9CFF5","orderCost":"0","quantity":"1","status":"success",
"paidBy":"Free","paidTo":null,"refundAmount":null,
"purchaseDate":"2013-11-05","name":"Pankaj Kumar", "email":"dummy@mydummydomain.com","city":null,"state":null,"country":null,"address":null,
"zipcode":null,"phoneNo":"8105262764","attendee":{"ticketName":"Free Visit","ticketId":"TKEFAJA",
"name":"Pankaj Kumar","email":"","checkin":"no","ticketNo":"E4CACB-688","status":"attending",
"details":{"Date":""}}},{"orderNo":"E4CACBXXXXX5253D507BB4DC","orderCost":"352.36","quantity":"2",
"status":"success","paidBy":"COD","paidTo":"Explara","refundAmount":null,"purchaseDate":"2013-10-09",
"name":"Pankaj Kumar","email":"dummy@mydummydomain.com","city":"Pune","state":"Maharashtra",
"country":"India","address":"aaaaa","zipcode":"411027","phoneNo":"98877889990",
"attendee":{"ticketName":"New Pricing 4","ticketId":"TKEFJJD","name":"PankajKumar",
"email":"dummy@mydummydomain.com","checkin":"no","ticketNo":"E4CACB-682","status":"attending",
"details":{"Date":""}}}]}
Note: Please refer errorCode and successCode.
Booking API Documentation

Booking API : Offer registration related services booking!

To access Explara API you need access token.

NOTE :All requests with OAuth2 tokens must be made over SSL.

1. Booking request
Require Fields
ParameterDescription
amount Amount to collected from Customer (Float Value). [Mandatory]
orderNoYour Order No. [Mandatory]
nameBuyer Name (Max. 200 Character)
emailId Buyer Email Id (Max 200 Character)
phoneNo Buyer Phone No. (Max 30 Character)
country Buyer Billing Country (Max 1000 Character)
state Buyer Billing State
cityBuyer Billing City
address Buyer Billing Address (Max 1000 Character)
zipcode Buyer Billing Zip code
bookingKey Your Explara Booking Key. (Booking Key) [Mandatory] (Contact support@explara.com for your Booking Key)
callbackUrl Return URL (Your page URL where want to get response). [Mandatory]
currencyCurrency (default INR)(INR, USD, GBP, EUR, PHP, ZAR).
pg Payment Gateway (default pg2)(pg1, pg2). [pg1: with MASTER/MAESTRO, pg2 : without MASTER/MAESTRO]
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/em/booking
MethodPOST
Response Encrypted response. (Use base64 to decrypt the response.) [response = base64 encrypted(orderNo|status|amount|md5 encrypted(Your Private Key))].
NOTE :All International currency will be converted to INR.
2. Get Booking order List

NOTE : All requests with OAuth tokens must be made over SSL. Additional request headers are required when using access_tokens to use Explara API: “Authorization: Bearer YOUR_ACCESS_TOKEN_HERE“.

Require Fields
ParameterDescription
fromDate From date
toDate to Date
bookingKey Your booking key
Request/Response:
Request/ResponseDescription
Request URLhttps://www.explara.com/api/e/get-booking-list
Response Typejson
Response {"status":"success","tickets":[{"id":"54","clientId":"PGAPIEPKB","cOrderNo":"ORD001012","orderNo":"ORD001012","name":"Dummy Text","emailId":"dummy@explara.com","phoneNo":"0202321664","address":"Dummy Address, Pune, Maharashtra, India, 411048","state":null,"city":null,"country":null,"zipcode":null,"amount":"1000","status":"processed","orderStatus":"processed","date":"2013-07-31","rUrl":"http:\/\/abc.com"}]}
Error Codes
CodeDescription
S001Event is created successfully
S002Event is updated successfully
S003Ticket created successfully
S004Discount created successfully
E001Invalid API Key or Private Key
E002All mandatory fields are required
E003End date time should be greater than Start date time
E004Start date should be greater than or equal to today's date
E005Subdomain already used by other user. Try other subdomain name
E006URL is already used in other event. Try other URL
E007Invalid Event Id
E008Invalid API Key for given Event Id or Invalid API key for requested API (Use Admin account's access token to use this API)
E009URL is already used by other event. Try other URL
E010Invalid Location Id
E011Some error occured. Pleae try later
E012Invalid Ticket Id
E013Only numeric character allowed in quantity
E014Only numeric character allowed in price
E015Quantity is required
E016Ticket Name is required
E017Start time format is incorrect
E018End time format is incorrect
E019Invalid Discount Id
E020Invalid Publisher Key
E021Category is required
E022Response Private Key is not matching
E023Is there a bot? We are getting too many request from you!
E024URL is required
E025Code is needed for code discount
E026From & To quantity is needed for bulk discount
E027Ticket is already sold.So it can't be updated
E028Discount does not belong to this event
D001Discount amount is required
T001Invalid request. Request Ticket is missing
T002User Billing information is missing
T003Invalid hash
T004No quantity selected
T005System is busy. Please try later
T006Please try after some time
T007Order not exist
T008OrderNo is not valid for given publisher key
T009Date Range should be less then or equal to 31
T010Duplicate order no. Order is already processed

Solutions

Products

Solutions For

Company

Stay in touch with us

Singapore

20 Upper Circular Road #03-06

The Riverwalk Singapore 058416

+65 8309 9411

India

#18, 2nd Floor, 80ft. Road,

Koramangala 4th Block, Bangalore 560034

+91 969 9611 666

Compare Explara with Cvent, Eventbrite, Peatix and more

© 2008 - 2024 Signure Technologies Pvt. Ltd. All Rights Reserved.

C I N: U74140KA2007PTC097586