introduction
To use the API, it's crucial to acquire API keys and user tokens (except signup and signin) for all Imprxx integrations. Additionally, for
security and flexibility, consider storing the API key and base URL in an environment (env) file,
enabling dynamic changes.
base_url (api.imprxx.com/api/v1)
user account
account sign up
This endpoint handle the creation of user.
free plan
POST
{base_url}/register
Header
Authenticate this API call by including the API key in the request header.
body param
String
User email required.
userName
String
UserName required.
signupType
String
Specify the user signup type as follow entertainer or anchor or centres or enduser (lowercase) required.
subcriptionPlan
String
Specify the user subscription type as follow basic or standard or premium(lowercase) required.
amount
String
amount required.
city
String
city required.
country
String
country required.
user password
String
User password required.
duration
String
duration optional.
request
copied
{ "email": "obafemidavid@gmail.com", "userName" : "davprince", "signupType": "entertainer", "subscriptionPlan" : "basic", "amount" : 0, "address" : "lagos nigeria", "password" : "12345", "duration" : "dialy" }
response
copied
{ "requestSuccessful": true, "responseMessage": "success", "responseBody": { "id": "imprxxuser1265b905b5ce1b9", "email": "obafemidavid@gmail.com", "userType": "entertainer", "subscriptionPlan": "basic", "duration": null, "address" : "lagos nigeria", "userWallet": { "error": "user wallet not activated" } }, "token": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNjliYWFkNzA3NDQxYjhjOGJkOTk5ZDJiOTM0ZWJhMTk4MjU5NDJmMTU1MzFkZWNhNDE2OGZlZjcyMzk0NTk3YjY3NzMxODFlNDM3MmY3YWUiLCJpYXQiOjE3MDY2MjQ0MzkuNTUyNTY1LCJuYmYiOjE3MDY2MjQ0MzkuNTUyNTc0LCJleHAiOjE3MzgyNDY4MzkuMTgzMDk3LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.aHjXgyT8NjhEw6NprVrfkWAXX2aj3WcSEh0oTLfmuCjyY24Gb7r5A8Y5Zn-2SNoCEM6WyIyb0RMs0VjHldU_tCKjk1FsUiRM_PatsvR8kVViE0sQHq-ubDAQHleqXV0zLyA5XUhSbv0Xph2TOW9ItupkNIUInloHroueAM8-oLTxjLJxS6de5itclkkyN7zEo0b2ieVtWgg_O0HxlMwIsiH1b7eUnUjUnTfauo_xnhG-X3ENZ5AT18HlGkinvghBFd8DFPbblGJVmvSg7RGutiRPtpwItlXZje_W7YDPOf1URVPUDaCNHzhG2OvZsSQ4kpyv5SNlVRdBlWU6xdnnDbGcmKqKSRYlCHrRx66t2Ln99dOVY7kgHJYlUOHNfzet9Va4Z5RSXwWBn6yObFHL9DcM2ZRLmOrvOrX8n1fIYbO_usPG9u5gOL61ZYw1qs4PqWmtw936Foru2mDr432n4P-zmpvYf7dLxJjMrUle18LjlYxyfvRTY_HLdtPDmDi60S-9VWKVaPPFfhZrSPt6tb0tUpVdV5BwY1OQc3UEKMAPv8G9JgXIQCl4qwwoLHLXLACTaqduWgk2sPI5NSbcOtx9yZp57eIkM-_mkrUaAvjO7KMIUzfv6gIcIwojg4s9IlVPJqsxiJDj9KSQHMpG809jbFEyrnboqHuzFiZUdEw" }
account sign up
This endpoint handle the creation of user.
paid plan
POST
{base_url}/register
Header
Authenticate this API call by including the API key in the request header.
body param
String
User email required.
userName
String
UserName required.
signupType
String
Specify the user signup type as follow entertainer or interface or enduser or broadcaster(lowercase) required.
subcriptionPlan
String
Specify the user subscription type as follow basic or standard or premium(lowercase) required.
user password
String
User password required.
amount
String
amount required.
customerName
String
customerName required.
duration
String
duration required.
cardNumber
String
cardNumber required.
expiryMonth
String
expiryMonth required.
pin
String
card pin required.
cvv
String
cvv required.
request
copied
{ "email": "obafemidavidadee@gmail.com", "userName" : "davprince", "signupType": "entertainer", "subscriptionPlan" : "basic", "amount" : 20, "password" : "12345", "customerName" : "obafemi david", "duration" : "daily", "cardNumber" : "53994120333329", "expiryMonth": "10", "expiryYear": "2024", "pin" : "1225", "cvv" : "513" }
response
copied
{ "result": { "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "status": "OTP_AUTHORIZATION_REQUIRED", "message": "Kindly enter the OTP sent to ********885 and oba***@gmail.com", "otpData": { "id": "1293427227", "message": "Kindly enter the OTP sent to ********885 and oba***@gmail.com", "transactionReference": "MNFY|69|20240130153138|005109", "responseCode": "T0", "amount": "20.00", "statusCode": 202, "authData": "a0PpjsKLl5pJ7jJdez9MPS7C49jOpqxkiDokC0tN7lTlz8AZAo5Wm7It3V8dkpWrcM4fL7PImWHC9uRzwbe3hMcKFA4cbYOjgRkPE/e3sPxqjBl0lj082iER7qV+QiHtamD4t1zk8Q7ng3frECtAQtg7oh/X4xbd7iuEhgTxF2FAsmXbvl8lhFBclxletVl1XMslD3boQUMezoO5WbyDcDRLcrpF8t2Ynj1o5wGbbSdNSV34YhD48rnscp0NwkAPsygMVOmAW0rD3TO51UdnnyTEELfPVCC5suplyptSIsD6DEoiWLo64BH85lAfkMBMjsSCVKUK3cxXiA0MdBR+hA==" }, "transactionReference": "MNFY|69|20240130153138|005109", "paymentReference": "imprxx payment ref 65b908511ba75", "authorizedAmount": 20 } }, "userAuth": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsibW9ubmlmeS12YWx1ZS1hZGRlZC1zZXJ2aWNlIiwibW9ubmlmeS1wYXltZW50LWVuZ2luZSIsIm1vbm5pZnktZGlzYnVyc2VtZW50LXNlcnZpY2UiLCJtb25uaWZ5LW9mZmxpbmUtcGF5bWVudC1zZXJ2aWNlIl0sInNjb3BlIjpbInByb2ZpbGUiXSwiZXhwIjoxNzA2NjI1MTgyLCJhdXRob3JpdGllcyI6WyJNUEVfTUFOQUdFX0xJTUlUX1BST0ZJTEUiLCJNUEVfVVBEQVRFX1JFU0VSVkVEX0FDQ09VTlQiLCJNUEVfSU5JVElBTElaRV9QQVlNRU5UIiwiTVBFX1JFU0VSVkVfQUNDT1VOVCIsIk1QRV9DQU5fUkVUUklFVkVfVFJBTlNBQ1RJT04iLCJNUEVfUkVUUklFVkVfUkVTRVJWRURfQUNDT1VOVCIsIk1QRV9ERUxFVEVfUkVTRVJWRURfQUNDT1VOVCIsIk1QRV9SRVRSSUVWRV9SRVNFUlZFRF9BQ0NPVU5UX1RSQU5TQUNUSU9OUyJdLCJqdGkiOiIzMjIzNjQ0Ni0zZTZmLTQzNmItOTVlOS1hMTNkZTE4ODZlYzgiLCJjbGllbnRfaWQiOiJNS19QUk9EX1I5TUM5MTJZVUwifQ.ZRKs4CwtLIwGyizpXgWKOZdsszeCCkKa1uMEJPMCBfQkmGOMyPL_K4GOWRF8nwh2OUH3Gtd6eQX-EAncjIkNBX-Ykrkwk0dD9PSetRruiwVaZJnp6lxokHp3KbwCKRImGtnGsIiRA79u9nymlTqfO-3TcYuwJ0PENogerxT5SVowlAFnigqpjwSmIhlhwnHf9gRXA89FkR1aRIQ6C3JJGgODVR7-VVRhP0U-QxH46ppZmtU6GiK_0kmU5LKeBV6ZcMqFfrWYVYJdFbOWk6Fi7y3AsXFyLVsH_wqf_44gvsRtTYOeUD8jjRDnewzfAfXTHmDaCMg6aArg1i4xxDU5uQ", "email": "obafemidavidadee@gmail.com", "signup_type": null, "subscription_plan": null, "duration": "daily" }
card otp
This endpoint handle the card payment, authorized otp and creation of user.
POST
{base_url}/registertoken
Header
Authenticate this API call by including the API key in the request header.
body param
userAuth
String
userAuth from the card payment response required.
transactionReference
String
transactionReference from the card payment response required.
tokenId
String
id from the card payment response required.
tokenId
String
id from the card payment response required.
token
String
token sent to the email or phonenumber required.
String
email from the card payment response required.
userName
String
userName from the card payment response required.
user password
String
User password required.
duration
String
Duration from the card payment required.
signupType
String
signupType from the card payment response required.
subcriptionPlan
String
subscriptionPlan from the card payment response required.
request
copied
{ "userAuth" : "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsibW9ubmlmeS12YWx1ZS1hZGRlZC1zZXJ2aWNlIiwibW9ubmlmeS1wYXltZW50LWVuZ2luZSIsIm1vbm5pZnktZGlzYnVyc2VtZW50LXNlcnZpY2UiLCJtb25uaWZ5LW9mZmxpbmUtcGF5bWVudC1zZXJ2aWNlIl0sInNjb3BlIjpbInByb2ZpbGUiXSwiZXhwIjoxNzA2NjI5MjQ5LCJhdXRob3JpdGllcyI6WyJNUEVfTUFOQUdFX0xJTUlUX1BST0ZJTEUiLCJNUEVfVVBEQVRFX1JFU0VSVkVEX0FDQ09VTlQiLCJNUEVfSU5JVElBTElaRV9QQVlNRU5UIiwiTVBFX1JFU0VSVkVfQUNDT1VOVCIsIk1QRV9DQU5fUkVUUklFVkVfVFJBTlNBQ1RJT04iLCJNUEVfUkVUUklFVkVfUkVTRVJWRURfQUNDT1VOVCIsIk1QRV9ERUxFVEVfUkVTRVJWRURfQUNDT1VOVCIsIk1QRV9SRVRSSUVWRV9SRVNFUlZFRF9BQ0NPVU5UX1RSQU5TQUNUSU9OUyJdLCJqdGkiOiI2NjMzMDdlMi0yNDljLTQ3ZjMtYTZiYi0zYjJjMmUwMDM4NTMiLCJjbGllbnRfaWQiOiJNS19QUk9EX1I5TUM5MTJZVUwifQ.FCC70cbb_Lav8rv7SJnU10j78SHsE1zc3SpeEKNlfRV34JvKGzTw2k3jrv28ko7Y1TuVOU2vKMYSV0ah0xURz7J9U9WqvHFGTuRgMXqbl7mw1QMybDWU-Cvlp6Fe_kbkXwlL9OXOY8UCKx64GFgjOIUM1H3XjmuPia85VotQN83_27t_BPsrScbP4VeWNlzN5zKpiSAr-qIJq-NLhjJ0g7QRMluOc5e1-CdYiJ4aAMTpkWEt8KOkDlF2nSsCWyzVmjdwQf960vUwGRVzuD1kFmoqYNHJeotCf65zQ8ohyUC6vosE8i0SG2JgmCdM88Blm9PjD4ml-XNRxshKcG1gtQ", "transactionReference":"MNFY|69|20240130155236|005394", "tokenId": "1293440651", "token": "359006", "email": "obafemidavidadeniy@gmail.com", "userName" : "davprince", "password" : "12345", "duration" : "daily", "signupType": "entertainer", "subscriptionPlan" : "basic" }
response
copied
{ "requestSuccessful": true, "responseMessage": "success", "responseBody": { "id": "imprxxuser5565b90d9032c88", "email": "obafemidavidadeniy@gmail.com", "signupType": "entertainer", "subscriptionPlan" : "basic", "duration": "Null", "userWallet": { "error": "user wallet not activated" } }, "token": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiOGE2MzViMzQzYzhmNDM0NzAwZjIyMTcxZjVlY2ZiZGJmNjMzNWQxYmJiNWY2YjM0MGFmYzAwODUzZDc4MTlhMWYzNjhlZjUwY2Q0MDc5NzciLCJpYXQiOjE3MDY2MjY0NDkuMjkyODY4LCJuYmYiOjE3MDY2MjY0NDkuMjkyODc2LCJleHAiOjE3MzgyNDg4NDkuMjIxODgsInN1YiI6IjMiLCJzY29wZXMiOltdfQ.jpoxwdDfElKI8t3mfqF1xY9GejgafIRiAaQWG8SNwuqxkR8X8ZBp_fbbkI_a05ONM0en4KwLJJFC7-9FbQH95beUSgxNkBnUyTh_X0byunY_qZRP6mbpRlBSwtykVf5mDI1Acyl8ePbRj9JjKo4z-RByfgfP-WnP25ZMpDs0Btx13aruymuA7kaivatOW3FC4XJvAD5IdPk2_E7fNCqId1IRs0I6IW8skZ1sbmgmqfYbiKNYWKb3WzXtDvZ3t8zuyY30TRre09Gl_ehIrccVie7Dh1R1QozSgQUqczS0nmitgszLtm5z0Gakasqy_z3rN1GTcz2vODI4BFzg8bT8m3B5sxw-cvQWyWmgSM9fmTs6BMIugWNP8np81-4ZoQ-kFyMhvdEaG6oSszb4kh9zxelIQxzYb_pnCfN9_ITrHhZudC4SMeYU9Bi_O8vwhjc3SeFLj-go9pUOQ6uGux8SVt7N3Zo_ZnZTLxvYvoCeQ3VYoVqQ6FsRJofGDtwLPaZVLJeDRjZOvxxEBAgqM5B1OZCKbhC6z_Y7rlFhTiRxicY5-4_NVJ4yLpAn-YGRfZ6PV7AQ5Z6oCrwWzBVJHhboGfkKxopAJ3NLEW7ia8jpRoBzH8VtrGYGWrSmhLjw6wMgGQNb_3qQPNYjzFp4JrUF0FUfKhtwjnMWIXi7oTBUABQ" }
account sign in
This endpoint handle the user sign in.
POST
{base_url}/login
Header
Authenticate this API call by including the API key in the request header.
body param
String
User email required.
user password
String
User password required.
request
copied
{ "email": "obafemidavid@gmail.com", "password": "12345" }
response
copied
{ "requestSuccessful": true, "responseMessage": "success", "responseBody": { "id": "imprxxuser1265b905b5ce1b9", "email": "obafemidavid@gmail.com", "userType": "entertainer", "subscriptionPlan": "basic", "duration": null, "userWallet": { "error": "user wallet not activated" } }, "token": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiYjkwYmQwMmI0NDMzMWIxNGVhZDQ4YTQ2ZmZiODQzYmZkNWZjODE4ZmEyYjVlNDQ5ZTJhYWFkYzlhMDg4NTM0ZWM1YTZkYjI5NjUxZGJhYjQiLCJpYXQiOjE3MDY2MjQ1MzguNTU5MzgyLCJuYmYiOjE3MDY2MjQ1MzguNTU5MzkzLCJleHAiOjE3MzgyNDY5MzguNDg3NzA1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.f5sqwuot-B-vxyOEM_NsIF0XVsC1T3sx_ot3c6Yw6oT96q4pr8egxSWBE6AZY-LyXzJld2AEraGkqTmE53FlyOb_1pcL93QP8YqCUDF1LVqjL5AFzJ1mCorUtUITeFqG-y4KVJp72e5Fu646r66FB0-Yzothio1KHWdynwgiv3keVH0dKti-WmSAEtYuL22unGoqYznatb5iHJMtu5oes04a-WRds5CTVGZQNxXLkCYUnLHxYzUOTi1YhNTR1_NmfRrA01qrMD_QKPp3XL_8G5y_w95rLwSA9dS1AhALJY4zJ21I9GQf_RUbzuEW0jvuChALv3zML9AwsQAGNRp69U_Hzvzl_ityzq8cEIOgfSaSKv84Ap7Bw0VbqRJZzf9qgZ-eM7Zz2qFVfFFJsJUyZmmdqvws0Ydr1PGYCIpguewHjMdJS5h1rqNekgbZKgcDDGn6oNNJdc4Fyt6jlyy6iIVoBcjQPpNVenvpNqY1BXvpsjKzm4TtcMR0k56RNJo5k2Rj3l5IQ9TZAk6mVPzQXvdah353wEG7jjMg6W5gRJ0QEWuMxVMXtXu8jlec2JLI2u1z-rvIee2lVVJazABizyCyTxu4LKCausV-b_C21oapwOuc-RAiIdXnhuzuRW0BmWnaHuxkGoCDabn8CpRahOTdwaleUzZFvLORSQcWXOM" }
create personal profile
This endpoint handle the user profile.
POST
{base_url}/personalprofile
Header
Authenticate this API call by including the API key and token in the request header.
body param
full name
String
full name required
dob (date of birth)
String
dob required
gender
String
gender required
weddingDate
String
weddingDate required
business name
String
business name optional.
phone number
String
phonenumber optional.
facebook handle
String
facebook handle optional.
facebook followers
String
facebook followers optional.
instagram handle
String
instagram handle optional.
instagram followers
String
instagram followers optional.
tiktok handle
String
tiktok handle optional.
tiktok followers
String
tiktok followers optional.
x handle
String
x handle optional.
x followers
String
x followers optional.
youtube channel
String
youtube followers optional.
youtube followers
String
youtube followers optional.
snapchat handle
String
snapchat handle optional.
snapchat followers
String
snapchat followers optional.
profileImage
file (img, png, jpeg)
User profile image optional.
request
copied
{ "fullName" : "david", "dob" : "18th/jan/2024", "gender" : "male", "phoneNumber" : "08134678909", "weddingDate" : "10/dec/2023", "businessName" : "dav", "phoneNumber" : "111112", "facebookHandle" : "dd", "facebookFollowers" : "11", "instagramHandle" : "ddd", "instagramFollowers" : "112", "tiktokHandle" : "dddd2", "tiktokFollowers" : "1221", "xHandle" : "dddd", "xFollowers" : "1211", "youtubeHandle" : "dav", "youtubeFollowers" : "1213", "profileImage", fileInput.files[0], "/C:/Users/DELL/Pictures/Camera Roll/WIN_20220610_164221.JPG" }
response
copied
{ "resquestSuccessful": true, "responseMessage": "success", "responseBody": { "email": "obafemidavprincccvee@gmail.com", "fullName": "david", "dob": "18th/jan/2024", "gender": "male", "weddingDate": "10/dec/2023", "businessName": "hcomfort", "phoneNumber": "08134678909", "facebookHandle": "facebook.com/hcomfort", "facebookFollowers": "10000", "instagramHandle": "instagram.com/hcomfort", "instagramFollowers": "1000", "tiktokHandle": "tiktok.com/hcomfort", "tiktokFollowers": "1929", "xHandle": "x.com/hcomfort", "xFollowers": "10000", "youtubeHandle": "youtube.com/hcomfort", "youtubeFollowers": "10000", "profileImg": "http://127.0.0.1:8000/uploads/1721308005.jpg" } }
create dedicated slide
This endpoint handle the dedicated slide.
POST
{base_url}/dedicatedslide
Header
Authenticate this API call by including the API key and token in the request header.
body param
dedicatedSlide
Image
dedicated slide required
request
copied
{ "dedicatedSlide": fileInput.files[0], "/C:/Users/DELL/Pictures/Camera Roll/WIN_20220610_164221.JPG" }
response
copied
{ "requestSuccessful": true, "responseMessage": "dedicate slidder created successfully", "responseBody": { "id": 4, "image": "http://127.0.0.1:8000/uploads/1721301512.png" } }
create profile page
This endpoint handle the user profile page.
POST
{base_url}/profilepage
Header
Authenticate this API call by including the API key and token in the request header.
body param
stageName
String
stageName required
biography
String
biography required
industry
String
industry required
genre
String
genre required
String
facebook required
x
String
x required
String
instagram required
tiktok
String
tiktok required
youtube
String
youtube required
dedicatedId
Array
dedicatedId required
request
copied
{ "stageName":"davido", "biography":"davido is a hip hop artiste hdjvdcjbcjc", "industry":"music", "genre":"apala", "facebook":"facebook.com/davido", "x":"x.com/davido", "instagram":"instagram.com/davido", "tiktok":"tiktok.com/davido", "youtube":"youtube.com/davido", "dedicatedId":[1, 2,3] }
response
copied
{ "requestSuccessful": true, "responseMessage": "profile page created successfully" }
forget password
This endpoint handle the forget password.
POST
{base_url}/forgetpassword
Header
Authenticate this API call by including the API key in the request header.
body param
String
email required.
request
copied
{ "email" : "obafemidavprince@gmail.com" }
response
copied
{ "requestSuccessful": true, "responseMessage": "Otp sent to your email for reset password!" }
confirm otp and change password
This endpoint handle the forget password otp and change password.
POST
{base_url}/passwordtoken
Header
Authenticate this API call by including the API key in the request header.
body param
token
Interger
token required.
newPassword
String
Note : if token is correct newPassword is required if not optional.
request
copied
{ "token": 518680, "newPassword" : "12345" }
response
copied
{ "requestSuccessful": true, "responseMessage": "password reset successfully!" }
change password
This endpoint handle the user password.
PUT
{base_url}/changepassword
Header
Authenticate this API call by including the API key and token in the request header.
body param
current password
String
User current password required.
new password
String
User new password required.
request
copied
{ "currentPassword" : "123456", "newPassword" : "12345" }
response
copied
[ { "requestSuccessful" => true, "responseMessage" => "password successfully changed" } ]
get user
This endpoint get user details.
GET
{base_url}/getuser
Header
Authenticate this API call by including the API key and token in the request header.
body param
response
copied
[ 007eJxTYDiYyD6rLslxrS3Lp7uGr9OOOPHeDLr1dp7Wt1lTzdrYBQMUGEwtzFIskwyTUpOSjE2SLNMsEpPSkpKTTY0TzZOT0sxMv0uEpzUEMjJsEuxlZmSAQBAQY8jMLSiqqEgtS80rKcrKS8qpLDEvLSzkYjCysDAyNjE0MjcGAG3yKNk= ][ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "userId": "imprxxuser5565b90d9032c88", "email": "obafemidavidadeniyi@gmail.com", "userType": "en", "subscriptionPlan": null, "duration": "Null", "userWallet": { "walletBalance": 0, "tippingBalance": 0, "tippingAvailableBalance": null, "userAccNumber": "2374289281", "userAccName": "DAVID OBAFEMI", "userBankName": "Zenith Bank International" }, "profile": { "userId": "imprxxuser5565b90d9032c88", "fullName": "david adeniyi", "userName": "zeb", "businessName": "dav", "phoneNumber": "111112", "facebookHandle": "dd", "facebookFollower": "11", "instagramHandle": "ddd", "instagramFollower": "112", "tiktokHandle": "dddd2", "tiktokFollower": "1221", "xHandle": "dddd", "xFollower": "1211", "youtubeHandle": "dav", "youtubeFollower": "1213", "profileImage": "/uploads/1706711214.jpg", "stageProfile": { "stageName": "k1 ultimate", "biography": "nnnfnnfnffn", "stageFacebookHandle": "https://facebook.com/davprincecode", "stageInstagramHandle": "eerr", "stageXHandle": "hfhfhfh", "stageImage": "/uploads/1706712180.jpg" } }, "sprayPerClick": null } } ]
entertainer apis
get all entertainers
This endpoint get you all entertainer users.
GET
{base_url}/getallent
Header
Authenticate this API call by including the API key and token in the request header.
body param
request
copied
{base_url}/getallent
response
copied
[ { "requestSuccess": true, "responseMessage": "success", "responseBody": { "userId": "imprxxuser3665b90543048f1", "email": "obafemidavprince@gmail.com", "subcriptionPlan": null, "profile": { "userName": "davprince", "businessName": "hcomfort", "phoneNumber": "08134678909", "facebookHandle": "facebook.com/hcomfort", "facebookFollower": null, "instagramHandle": "instagram.com/hcomfort", "instagramFollower": "1000", "tiktokHandle": "tiktok.com/hcomfort", "tiktokFollowers": "1929", "xHandle": "x.com/hcomfort", "xFollowers": "10000", "youtubeHandle": "youtube.com/hcomfort", "youtubeFollowers": "10000", "profileImage": "/uploads/1706968720.png", "stageProfile": { "stageName": "davido", "biography": "davido is a hip hop artiste hdjvdcjbcjc", "stageFacebookHandle": "facebook.com/davido", "stageInstagramHandle": "instagram.com/davido", "stageXHandle": "x.com/davido", "stageImage": "/uploads/1706969082.png" } } } }, { "requestSuccess": true, "responseMessage": "success", "responseBody": { "userId": "imprxxuser1265b905b5ce1b9", "email": "obafemidavid@gmail.com", "subcriptionPlan": null, "profile": { "userName": "davprince", "businessName": "hcomfort", "phoneNumber": "08134678909", "facebookHandle": "facebook.com/hcomfort", "facebookFollower": "11", "instagramHandle": "instagram.com/hcomfort", "instagramFollower": "1000", "tiktokHandle": "tiktok.com/hcomfort", "tiktokFollowers": "1929", "xHandle": "x.com/hcomfort", "xFollowers": "10000", "youtubeHandle": "youtube.com/hcomfort", "youtubeFollowers": "10000", "profileImage": "/uploads/1706968493.jpg", "stageProfile": { "stageName": "k1 ultimate", "biography": "nnnfnnfnffn", "stageFacebookHandle": "https://facebook.com/davprincecode", "stageInstagramHandle": "eerr", "stageXHandle": "hfhfhfh", "stageImage": "/uploads/1706712180.jpg" } } } }, { "requestSuccess": true, "responseMessage": "success", "responseBody": { "userId": "imprxxuser6365be42de12157", "email": "davidsmith@gmail.com", "subcriptionPlan": null, "profile": null } }, { "requestSuccess": true, "responseMessage": "success", "responseBody": { "userId": "imprxxuser7565be431b19b55", "email": "johnjoe@gmail.com", "subcriptionPlan": null, "profile": null } } ]
get entertainer profile
This endpoint get you entertainer profile.
GET
{base_url}/getentprofile
Header
Authenticate this API call by including the API key and token in the request header.
body param
request
copied
response
copied
[ { "requestSuccess": true, "responseMessage": "success", "responseBody": { "user_id": "imprxxuser1265b905b5ce1b9", "first_name": null, "last_name": null, "email": "obafemidavid@gmail.com", "phone_number": null, "type": null, "subcription_plan": null, "bio": null, "fab_handle": null, "insta_handle": null, "twitter_handle": null, "profile_img": null } } ]
live event
studio apis
guest category
This endpoint handle the guest category.
PUT
{base_url}guestCategory/{cat_id}
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is according to the category name from the above endpoint cat_id
body param
categoryName
String
categoryName required .
commenting
Boolean
commenting required.
liveTipping
Boolean
live tipping required.
videoChat
Boolean
video chat required.
specialRequest
Boolean
special Request required.
specialRequestNo
Interger
special Request number required.
cheerfulEntry
Boolean
cheerful entry required.
guestUpgrade
Boolean
guest upgrade required.
request
copied
{ "categoryName" : "regular", "commenting" : true, "liveTipping" : true, "videoChat" : true, "specialRequest" : true, "specialRequestNo" : 2, "cheerfulEntry" : true, "guestUpgrade" : false }
response
copied
{ "data": [ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "ticketId": "imprxxtckt65b9167e91a5e", "nameOfCategory": "regular", "availableTicket": 20, "currency": "$", "price": 1000, "discountPrice": 800, "discountTotalPrice": 800, "discountTotalQuantity": 8, "raffle": "raffle", "coupon": "coupon", "commenting": "1", "liveTipping": "1", "videoChat": "1", "specialRequest": "1", "specialRequestNo": "2", "cheerfulEntry": "1", "guestUpgrade": "0" } } ] }
video chat request
This endpoint handle user video request.
POST
{base_url}/videorequest
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is according to the ent id
body param
entId
String
entertainer id required.
eventId
String
eventId required.
request
copied
{ "entId" : "imprxxuser1265b905b5ce1b9", "eventId" : "imprxxevent65b91c759cde2" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "status": "pending" } } ]
video chat invite
This endpoint handle invitation sent to user.
POST
{base_url}/inviterequest
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is according to the ent id
body param
receiverId
String
receiverId id required.
eventId
String
eventId required.
request
copied
{ "receiverId" : "imprxxuser1265b905b5ce1b1", "eventId" : "imprxxevent65b91c759cde2" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b1", "eventId": "imprxxevent65b91c759cde2", "status": "invited" } } ]
video chat accepted
This endpoint handle accept invitation sent by entertainer.
POST
{base_url}/acceptrequest
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is according to the ent id
body param
entId
String
entertainer id required.
eventId
String
eventId required.
request
copied
{ "entId" : "imprxxuser1265b905b5ce1b9", "eventId" : "imprxxevent65b91c759cde2" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "status": "accepted" } } ]
get all video chat request
This endpoint get all video chat request.
GET
{base_url}/getvideorequestall/{eventId}
Header
Authenticate this API call by including the API key and token in the request header.
body param
eventId
Url Parameter
eventId required.
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "status": "accepted" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "status": "invited" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde22", "status": "invited" } } ]
get video chat request by a user
This endpoint get all video chat request by a user.
GET
{base_url}/getvideorequest/{userId}
Header
Authenticate this API call by including the API key and token in the request header.
body param
userId
Url Parameter
userId required.
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "senderId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde22", "status": "invited" } } ]
create brand
This endpoint handle the creation of brand.
POST
{base_url}/brand
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is brand
body param
eventId
String
The event id required .
brandColour
String
The brand colour required .
brandLogo
File (jpg, png, jpeg, gif, svg)
The brand logo required.
brandOverlay
String
brand overlay required.
brand background
String
brand background required.
request
copied
{ "eventId": "imprxxevent6540c57fc42f6", "brandColor": "#ff6347", "brandLogo": "sample.jpg", "brandOverlay": "gray", "brandBackground": "#ff6347" }
response
copied
[ 'requestSuccessful' => true, 'responseMessage' => 'success', 'responseBody' => { "brandId": "imprxxbrand655c02a0386ba", "entId": "imprxxuser49653d2ba255c55", "eventId": "imprxxevent6540c57fc42f6", "brandColor": "#ff6347", "brandLogo": "image/qaU3JUG7jY7kFvruDA0Otr6XISbhS9vkD4Sma0lh.jpg", "brandOverlay": "gray", "brandBackground": "#ff6347" } ]
get single brand
This endpoint handle the getting of single brand data.
GET
{base_url}/brand/{brand_id}
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Add brand unique id as path param
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is brand
body param
request
copied
{ "brandId": "imprxxbrand655c81999509b", }
response
copied
[ 'requestSuccessful' => true, 'responseMessage' => 'success', 'responseBody' => { "brandId": "imprxxbrand655c81999509b", "entId": "imprxxuser49653d2ba255c55", "eventId": "imprxxevent6540c57fc42f6", "brandColor": "#ff6347", "brandLogo": "image/UKBL0yZZjIB2DJ0Aj5BnNurjxkebz0IKriPKGXb3.png", "brandOverlay": "gray", "brandBackground": "#ff6347" } ]
Brand Edit/Update
This endpoint handle the brand update.
PUT
{base_url}/brand/{brand_id}
Header
Authenticate this API call by including the API key in the request header.
Add brand unique id as path param
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is brand
body param
eventId
String
The event id optional.
brandColour
String
The brand colour optional.
brandLogo
File (jpg, png, jpeg, gif, svg)
The brand logo optional.
brandOverlay
String
brand overlay optional.
brand background
String
brand background optional.
request
copied
{ "userId" : "imprxxuser49653d2ba255c55", "eventId" : "imprxxevent6540c57fc42f6", "brandColor" : "#ffffee", "brandOverlay" : "purple", "brandBackground" : "green" }
response
copied
[ 'requestSuccessful' => true, 'responseMessage' => 'success', 'responseBody' => { "brandId": "imprxxbrand655c81999509b", "entId": "imprxxuser49653d2ba255c55", "eventId": "imprxxevent6540c57fc42f6", "brandColor": "#ffffee", "brandLogo": "image/UKBL0yZZjIB2DJ0Aj5BnNurjxkebz0IKriPKGXb3.png", "brandOverlay": "purple", "brandBackground": "green" } ]
delete brand
This endpoint delete brand
DELETE
{base_url}/brand/{brand_id}
Header
Authenticate this API call by including the API key in the request header.
Add brand unique id as path param
body param
request
copied
{base_url}/brand/{brand_id}
response
copied
{ "requestSuccessful": true, "responseMessage": "brand deleted!" }
create banner
This endpoint handle the creation of banner.
POST
{base_url}/banner
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is banner
body param
eventId
String
The event id required .
bannerTitle
String
The banner title required .
scrollable
Boolean
scrollable required.
request
copied
{ "eventId" : "imprxxevent6540c57fc42f6", "bannerTitle" : "i love imprxx", "scrollable" : "true" }
response
copied
[ 'requestSuccessful' => true, 'responseMessage' => 'success', 'responseBody' => { "bannerId": "imprxxbanner655cc2003eb0e", "userId": "imprxxuser49653d2ba255c55", "eventId": "imprxxevent6540c57fc42f6", "bannerTitle": "i love imprxx", "scrollable": "true" } ]
get single banner
This endpoint handle the getting of single banner data.
GET
{base_url}/banner/{banner_id}
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Add banner unique id as path param
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is banner
body param
request
copied
{ "banner_id": "imprxxbanner655cc2003eb0e", }
response
copied
[ 'requestSuccessful' => true, 'responseMessage' => 'success', 'responseBody' => { "bannerId": "imprxxbanner655cc2003eb0e", "userId": "imprxxuser49653d2ba255c55", "eventId": "imprxxevent6540c57fc42f6", "bannerTitle": "i love imprxx", "scrollable": "true" } ]
banner Edit/Update
This endpoint handle the banner update.
PUT
{base_url}/banner/{banner_id}
Header
Authenticate this API call by including the API key in the request header.
Add banner unique id as path param
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is banner
body param
eventId
String
The event id optional.
bannerTitle
String
The banner title optional.
scrollable
Boolean
The scrollable optional.
request
copied
{ "eventId" : "imprxxevent6540c57fc42f6", "bannerTitle" : "k1 de ultimate show", "scrollable" : "false" }
response
copied
[ 'requestSuccessful' => true, 'responseMessage' => 'success', 'responseBody' => { "bannerId": "imprxxbanner655cc2003eb0e", "userId": "imprxxuser49653d2ba255c55", "eventId": "imprxxevent6540c57fc42f6", "bannerTitle": "k1 de ultimate show", "scrollable": "false" } ]
delete banner
This endpoint delete banner
DELETE
{base_url}/banner/{banner_id}
Header
Authenticate this API call by including the API key in the request header.
Add banner unique id as path param
body param
request
copied
{base_url}/banner/{banner_id}
response
copied
{ "requestSuccessful": 200, "responseMessage": "banner deleted!" }
create comment
This endpoint handle the creation of comment.
POST
{base_url}/comment
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is comment
body param
entId
String
Ent id required.
userId
String
The user id (commenting user) required .
username
String
username required .
eventId
Boolean
event id required.
catName
String
category name required.
message
string
message required.
commentTime
Boolean
commented time required.
request
copied
{ "ent_id" : "imprxxuser49653d2ba255c55", "user_id" : "imprxxuser97653d44802b0d7", "user_name" : "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "vvip", "message": "hello world", "comment_time": "11:30" }
response
copied
{ "data": { "comment_id": 3, "ent_id": "imprxxuser49653d2ba255c55", "user_id": "imprxxuser97653d44802b0d7", "user_name": "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "vvip", "message": "hello world", "date": "21/11/2023", "comment_time": "11:30" } }
get user comment
This endpoint handle user comment message.
GET
{base_url}/comment/{user_id}/{event_id}
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Add user and event unique id as path param
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is comment
body param
request
copied
{ "user_id": "imprxxuser97653d44802b0d7", "event_id": "imprxxevent6540c57fc42f6" }
response
copied
{ "data": [ { "comment_id": 2, "ent_id": "imprxxuser49653d2ba255c55", "user_id": "imprxxuser97653d44802b0d7", "user_name": "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "vvip", "message": "hello world", "date": "18/11/2023", "comment_time": "11:30" }, { "comment_id": 3, "ent_id": "imprxxuser49653d2ba255c55", "user_id": "imprxxuser97653d44802b0d7", "user_name": "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "vvip", "message": "hello world", "date": "21/11/2023", "comment_time": "11:30" } ] }
get entertainer comment
This endpoint handle entertainer comment message.
GET
{base_url}/comment/ent/{ent_id}/{event_id}
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Add ent and event unique id as path param
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is comment
body param
request
copied
{ "ent_id": "imprxxuser97653d44802b0d7", "event_id": "imprxxevent6540c57fc42f6" }
response
copied
{ "data": [ { "comment_id": 1, "ent_id": "imprxxuser49653d2ba255c55", "user_id": "imprxxuser97653d44802b0d7", "user_name": "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "vvip", "message": "hello world", "date": "18/11/2023", "comment_time": "11:30" }, { "comment_id": 2, "ent_id": "imprxxuser49653d2ba255c55", "user_id": "imprxxuser97653d44802b0d7", "user_name": "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "vvip", "message": "hello world", "date": "21/11/2023", "comment_time": "11:30" } ] }
comment Edit/Update
This endpoint handle the comment update.
PUT
{base_url}/comment/{user_id}/{event_id}/{comment_id}
Header
Authenticate this API call by including the API key in the request header.
Add user, comment and event unique id as path param
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is comment
body param
catName
String
category name optional.
message
String
message optional.
request
copied
{ "cat_name": "regular", "message": "nice content keep it up" }
response
copied
{ "data": [ { "comment_id": 3, "ent_id": "imprxxuser49653d2ba255c55", "user_id": "imprxxuser97653d44802b0d7", "user_name": "david", "event_id": "imprxxevent6540c57fc42f6", "cat_name": "regular", "message": "nice content keep it up", "date": "21/11/2023", "comment_time": "11:30" } ] }
delete comment
This endpoint delete comment
DELETE
{base_url}/comment/{comment_id}
Header
Authenticate this API call by including the API key in the request header.
Add comment unique id as path param
body param
request
copied
{base_url}/comment/{comment_id}
response
copied
{ "status": 200, "message": "comment deleted!" }
start live video
This endpoint handle the start live video.
POST
{base_url}/startlive
Header
Authenticate this API call by including the API key and token in the request header.
body param
eventId
String
eventId required.
eventLink
String
eventLink required .
request
copied
{ "eventId": "imprxxevent65b91c759cde2", "eventLink" : "davprice.com/live" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "eventLink": "davprice.com/live", "isLive": "true" } } ]
stop live video
This endpoint handle live video stoppage.
POST
{base_url}/stoplive
Header
Authenticate this API call by including the API key and token in the request header.
body param
eventId
String
eventId required.
request
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "eventLink": "davprice.com/live", "isLive": "false" } } ]
get all live video
This endpoint get all live video.
GET
{base_url}/getlive
Header
body param
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde2", "eventLink": "davprice.com/live", "isLive": "true" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65b91c759cde22", "eventLink": "davprice.com/live", "isLive": "true" } } ]
Get All Entertainer Sectional Viewing
This endpoint handle the creation of sectional viewing.
GET
{base_url}/studiosectionalsviewing/{user_id}/{event_id}
Header
Authenticate this API call by including the API key in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is sectional_viewing
body param
request
copied
{ "user_id" : "imprxxuser49653d2ba255c55", "event_id" : "imprxxevent6540c57fc42f6" }
response
copied
{ "data": [ { "sectional_viewing_id": "imprxxsectview654160bc455cc", "event_id": "imprxxevent6540c57fc42f6", "name_of_category": "regular", "currency": "$", "price": 1000, "reduction_ticket": 20, "time_interval": "10:30", "table_number": 0, "discount_quantity": 10, "discount_percentage": 20, "coupon_discount": 10, "raffle": "raffle", "coupon": "coupon" }, { "sectional_viewing_id": "imprxxsectview65416b8883413", "event_id": "imprxxevent6540c57fc42f6", "name_of_category": "vvip", "currency": "$", "price": 40, "reduction_ticket": 20, "time_interval": "30", "table_number": 4, "discount_quantity": 10, "discount_percentage": 20, "coupon_discount": 10, "raffle": "raffle", "coupon": "coupon" } ] }
update Sectional Viewing
This endpoint handle the update sectional viewing.
PUT
{base_url}/studiosectionalsviewing/{sectional_viewing_id}/{id}
Header
Authenticate this API call by including the API key in the request header.
Add sectional viewing sectional view and user id as path param
body param
name of category
String
name of category required.
currency
String
Currency required.
Price
Interger
price required.
reductionTicket
String
reduction ticket required.
tableNumber
Interger
table number required.
timeInterval
String
Time interval optional.
timeInterval
String
Time interval required.
request
copied
{ "name_of_category" : "vvip", "currency" :"$", "price" : 40, "reduction_ticket" : 20, "table_number": 4, "time_interval": "30" }
response
copied
{ "data": [ { "sectional_viewing_id": "imprxxsectview65416b8883413", "event_id": "imprxxevent6540c57fc42f6", "name_of_category": "vvip", "currency": "$", "price": 40, "reduction_ticket": 20, "time_interval": "30", "table_number": 4, "discount_quantity": 10, "discount_percentage": 20, "coupon_discount": 10, "raffle": "raffle", "coupon": "coupon" } ] }
delete Sectional Viewing
This endpoint delete sectional viewing
DELETE
{base_url}/studiosectionalsviewing/{sectional_viewing_id}
Header
Authenticate this API call by including the API key in the request header.
Add studio sectional viewing unique id as path param
body param
request
copied
{ sectional_viewing_id : "imprxxsectview65416b8883413" }
response
copied
{ "status": 202, "message": "sectional viewing deleted!" }
wallet apis
get wallet balance
This endpoint handle get the wallet balance.
GET
{base_url}/walletbalance
Header
Authenticate this API call by including the API key and token in the request header.
body param
request
copied
response
copied
{ "requestSuccessful": true, "responseMessage": "success", "responseBody": { "wallet_balance": 0 } }
get tipping balance
This endpoint get tipping balance.
GET
{base_url}/tippingbalance
Header
Authenticate this API call by including the API key and token in the request header.
body param
response
copied
{ "requestSuccessful": true, "responseMessage": "success", "responseBody": { "tipping_balance": 0, "available_tipping_balance": 0 } }
tipping spraying
This endpoint handle tipping spraying.
POST
{base_url}/spraytipping
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes or use any of your choice.
The web socket channel name is tipping_ plus the event id e.g (tipping_imprxxevent65b91c759cde2)
body param
request
copied
{ "recieverId" : "imprxxuser5565b90d9032c88" }
response
copied
{ "requestSuccessful": true, "responseMessage": "tipping sent successfully" }
livestreaming apis
get all live user
This endpoint get all live user.
GET
{base_url}/getlive
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is liveEvents
event name live
body param
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "eventName": "lovee", "eventLink": "https://api.imprxx.com/api/v1/home/livestreaming/imprxxevent65cfbfb1ded95/imprxxuser3665b90543048f1", "profileImg": "/uploads/1706968720.png", "stageName": "davido", "videoClip": null, "isLive": "true", "agoraToken": null } } ]
comment
This endpoint handle comment.
POST
{base_url}/comment
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is according to the event id
event name comment
body param
eventId
String
required
entId
String
required
catName
String
required
message
String
required
request
copied
{ "eventId": "imprxxevent65cfbfb1ded95", "entId" : "imprxxuser3665b90543048f1", "catName": "vvip", "message": "how are you doing" }
response
copied
{ "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser1265b905b5ce1b9", "userName": "davprince", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "how are you doing", "date": "21/05/2024", "commentTime": "11:42:50" }
get all comment
This endpoint get all comment.
POST
{base_url}/getallComment
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is according to the event id
event name comment
body param
eventId
String
required
entId
String
required
request
copied
{ "eventId": "imprxxevent65cfbfb1ded95", "entId" : "imprxxuser3665b90543048f1" }
response
copied
[ { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser87664470c36d064", "userName": "Favourkass", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "hello", "date": "15/05/2024", "commentTime": "10:15:49" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser3665b90543048f1", "userName": "davprince", "eventId": "imprxxevent65cfbfb1ded95", "catName": "ent", "message": "am good we moving forward", "date": "11/05/2024", "commentTime": "13:31:23" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser6465c4d1ace424b", "userName": "----", "eventId": "imprxxevent65cfbfb1ded95", "catName": "regular", "message": "babababa'", "date": "11/05/2024", "commentTime": "13:29:33" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser6465c4d1ace424b", "userName": "----", "eventId": "imprxxevent65cfbfb1ded95", "catName": "regular", "message": "hahahha", "date": "11/05/2024", "commentTime": "13:29:28" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser6465c4d1ace424b", "userName": "----", "eventId": "imprxxevent65cfbfb1ded95", "catName": "regular", "message": "i am here", "date": "11/05/2024", "commentTime": "13:28:41" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser6465c4d1ace424b", "userName": "----", "eventId": "imprxxevent65cfbfb1ded95", "catName": "regular", "message": "comment", "date": "11/05/2024", "commentTime": "13:28:19" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser6465c4d1ace424b", "userName": "----", "eventId": "imprxxevent65cfbfb1ded95", "catName": "regular", "message": "Hello", "date": "10/05/2024", "commentTime": "13:31:37" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "heloo imprx", "date": "09/05/2024", "commentTime": "15:50:08" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser3665b90543048f1", "userName": "davprince", "eventId": "imprxxevent65cfbfb1ded95", "catName": "ent", "message": "please reduce the volume", "date": "09/05/2024", "commentTime": "15:43:51" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "hello world", "date": "09/05/2024", "commentTime": "15:43:26" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "hello world", "date": "09/05/2024", "commentTime": "15:43:22" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "nmnn", "date": "09/05/2024", "commentTime": "15:06:45" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "nmnn", "date": "09/05/2024", "commentTime": "15:06:45" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "mnmnmmnmmnm", "date": "09/05/2024", "commentTime": "15:06:37" }, { "entId": "imprxxuser3665b90543048f1", "userId": "imprxxuser5565b90d9032c88", "userName": "x", "eventId": "imprxxevent65cfbfb1ded95", "catName": "vvip", "message": "mnmnmmnmmnm", "date": "09/05/2024", "commentTime": "15:06:36" } ]
get all banner
This endpoint get all banner.
GET
{base_url}/getbanner/{event_id}
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is according to the event id
event name banner
body param
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerId": "imprxxbanner663bda7356551", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "bannerTitle": "hello", "bannerPosition": "top", "scrollable": "false", "status": "live" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerId": "imprxxbanner663c831a8f034", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "bannerTitle": "dav", "bannerPosition": "bottom", "scrollable": "true", "status": "live" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerId": "imprxxbanner663c831a8f034", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "bannerTitle": "hello", "bannerPosition": "bottom", "scrollable": "true", "status": "live" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerId": "imprxxbanner663c831a8f034", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "bannerTitle": "no scroll", "bannerPosition": "bottom", "scrollable": "true", "status": "live" } }, { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerId": "imprxxbanner663bda7356551", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "bannerTitle": "fixed btn", "bannerPosition": "bottom", "scrollable": "true", "status": "live" } } ]
get get image banner
This endpoint get image banner.
GET
{base_url}/getimagebanner/{event_id}
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is according to the event id
event name bannerImage
body param
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerImgId": "imprxxtextbanner663c8a4b04c3e", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "imgPath": "/uploads/1715243595.jpg", "status": "live" } } ]
get video banner/
This endpoint get video banner/.
GET
{base_url}/getvideobanner//{event_id}
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is according to the event id
event name bannerVideo
body param
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "bannerVideoId": "imprxxvideobanner663c8b4a98df7", "userId": "imprxxuser3665b90543048f1", "eventId": "imprxxevent65cfbfb1ded95", "videoPath": "/uploads/1715243850.mp4", "status": "live" } } ]
get video banner/
This endpoint get video banner/.
GET
{base_url}/getvideobanner//{event_id}
Header
Authenticate this API call by including the API key and token in the request header.
Channel Name
Note : you can either use laravel echo to listen to any event changes and pusher or use any of your choice.
The web socket channel name is according to the event id
event name guestinvite
body param
eventId
String
required
request
copied
{ "eventId": "imprxxevent65cfbfb1ded95" }
response
copied
{ "requestSuccessful": true, "responseMessage": "success", "responseBody": { "eventId": "imprxxevent65cfbfb1ded95", "userId": "imprxxuser1265b905b5ce1b9", "fullName": "obafemi david", "profileImg": "/uploads/1706968493.jpg", "displayName": null, "headLine": null, "status": "request", "liveStatus": "request" } }
start live
This endpoint allow user to start livestreaming.
POST
{base_url}/startlive
Header
Authenticate this API call by including the API key and token in the request header.
body param
eventId
String
event id required.
eventName
String
event name required.
eventLink
String
event link required.
profileImg
String
profile image required.
stageName
String
stage name required.
request
copied
{ "eventId": "imprxxevent65cfbfb1ded95", "eventName": "lovee", "eventLink": "https://api.imprxx.com/api/v1/home/livestreaming/imprxxevent65cfbfb1ded95/imprxxuser3665b90543048f1", "profileImg": "/uploads/1706968720.png", "stageName": "davido" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65cfbfb1ded95", "eventName": "lovee", "eventLink": "https://api.imprxx.com/api/v1/home/livestreaming/imprxxevent65cfbfb1ded95/imprxxuser3665b90543048f1", "profileImg": "/uploads/1706968720.png", "stageName": "davido", "videoClip": null, "isLive": "true", "agoraToken": "007eJxTYJjF7Pjg2Hbu9D3CR+JCp1XcFf580Hhf3g6v1mPWHlaWL3UUGEwtzFIskwyTUpOSjE2SLNMsEpPSkpKTTY0TzZOT0sxMU8+6pjUEMjJInlrFxMgAgSAgwZCZW1BUUZFalppXYmaanAbUZpiSmmJpKgmVKS1OLTI0MjNNsjQwTTJNTjVMsgQAghIvSQ==" } } ]
stop live
This endpoint allow user to stop livestreaming.
POST
{base_url}/stoplive
Header
Authenticate this API call by including the API key and token in the request header.
body param
eventId
String
event id required.
request
copied
{ "eventId": "imprxxevent65cfbfb1ded95" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "entId": "imprxxuser1265b905b5ce1b9", "eventId": "imprxxevent65cfbfb1ded95", "eventName": "lovee", "eventLink": "https://api.imprxx.com/api/v1/home/livestreaming/imprxxevent65cfbfb1ded95/imprxxuser3665b90543048f1", "profileImg": "/uploads/1706968720.png", "stageName": "davido", "videoClip": null, "isLive": "false", "agoraToken": null } } ]
agora token
This endpoint generate agora token without passing uid.
POST
{base_url}/agoratoken
Header
Authenticate this API call by including the API key and token in the request header.
body param
channelName
String
channel name required.
request
copied
{ "channelName": "imprxxevent65cfbfb1ded95" }
response
copied
[ 007eJxTYNjK9XfOHMNPck1zbmeFb2Z6yfrGzPHirwnrIxe1qDz4YfBUgcHUwizFMskwKTUpydgkyTLNIjEpLSk52dQ40Tw5Kc3MNOGKa1pDICPDdbvzDIxAyALEIMAEJpnBJAuYlGDIzC0oqqhILUvNKzEzTU4DGmSYkppiaSoJlSktTi0yNDIzTbI0ME0yTU41TLIEAO8MMd8= ]
agora token with uid
This endpoint generate agora token with passing uid.
POST
{base_url}/genagoratoken
Header
Authenticate this API call by including only the API key the request header.
body param
channelName
String
channel name required.
user_id
Interger
user_id required.
request
copied
{ "user_id" : 2882341273, "channelName" : "imprxxeventrjnblyt7uqq" }
response
copied
[ 007eJxTYDiYyD6rLslxrS3Lp7uGr9OOOPHeDLr1dp7Wt1lTzdrYBQMUGEwtzFIskwyTUpOSjE2SLNMsEpPSkpKTTY0TzZOT0sxMv0uEpzUEMjJsEuxlZmSAQBAQY8jMLSiqqEgtS80rKcrKS8qpLDEvLSzkYjCysDAyNjE0MjcGAG3yKNk= ]
unlock livestreaming video
This endpoint unlock the livestreaming video.
POST
{base_url}/confirmcode
Header
Authenticate this API call by including the API key and token in the request header.
body param
eventAccessCode
String
event access code required.
eventId
String
event id required.
request
copied
{ "eventAccessCode" : "imprxx6605d73c3b5cbticketb", "eventId" : "imprxxevent65cfbfb1ded95" }
response
copied
[ { "requestSuccessful": true, "responseMessage": "success", "responseBody": { "eventId": "imprxxevent65cfbfb1ded95", "eventName": "davido", "eventDate": "24/03/2024", "eventTime": "10:12", "entId": "imprxxuser3665b90543048f1", "amount": 50, "accessCode": "imprxx6605d73c3b5cbticketb", "accessedCode": "true", "tableNo": 1, "catId": "imprxxcatid65d3b833b7173", "catName": "vvip", "userId": "imprxxuser5565b90d9032c88", "userName": "davprince", "userEmail": "obafemidavidadeniyi@gmail.com", "paymentType": "card" } } ]