Scribd
Upload
208 views13 pages

Beep API Documentation

The BeepXtra API allows developers to access data using RESTful requests with various HTTP methods like GET, POST, PUT, DELETE. It has controllers for cards, libraries, platforms, products, and reports. Requests require authentication with an app ID and key. The document provides examples of API requests in PHP, cURL, and direct URLs for each available method.

Uploaded by

Suwardi Liwenzhong
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
208 views13 pages

Beep API Documentation

The BeepXtra API allows developers to access data using RESTful requests with various HTTP methods like GET, POST, PUT, DELETE. It has controllers for cards, libraries, platforms, products, and reports. Requests require authentication with an app ID and key. The document provides examples of API requests in PHP, cURL, and direct URLs for each available method.

Uploaded by

Suwardi Liwenzhong
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 13

BeepXtra API

The API accepts REST requests using the following methods:

GET

POST

PUT

DELETE

HEAD

e.g. if the request is GET /card/9 it will automatically return the card details in JSON format for processing

Configuration
appid : YOURAPPID

(You will receive this from out integrations department)

appkey : YOURAPPKEY (You will receive this from out integrations department)
format : json
referer: e.g. 'myePOS' (insert a unique referer. This will be used to identify your application requests for debugging purposes)
cookie : e.g. 'myePOS' (insert a unique cookie name. recommended to use the same as referer for consistency. Also for debugging purposes)

Available Requests

card Controller
owner
Get Card Owner
Accepts Card_No or email

PHP SDK Request:


$beepapi->request('get', 'card', 'owner/1');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X GET https://api.beepxtra.com/card/owner/1

REST Direct URL:


https://api.beepxtra.com/card/owner/1

balance
Get Card Balance
Accepts Card_no | email

PHP SDK Request:


$beepapi->request('get', 'card', 'balance/0000000000000009');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X GET https://api.beepxtra.com/card/balance/0000000000000009

REST Direct URL:

https://api.beepxtra.com/card/balance/0000000000000009

cashback
Post multiproduct cashback
multiproduct/simple | outlet_id-cashier_id | card number |
productid_priceeach_discountpercentage_quantity | receipt no ~ Returns True | error message

PHP SDK Request:


$beepapi->request('post', 'card', 'cashback/multiproduct/39154270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X POST https://api.beepxtra.com/card/cashback/multiproduct/39154270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123

REST Direct URL:


https://api.beepxtra.com/card/cashback/multiproduct/391-54270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123

Lib Controller
api
Get the access permissions for your app_id

PHP SDK Request:


$beepapi->request('get', 'lib', 'api');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|lib" -X GET https://api.beepxtra.com/lib/api

REST Direct URL:


https://api.beepxtra.com/lib/api

platform Controller
rates
Get All Exchange Rates

PHP SDK Request:


$beepapi->request('get', 'platform', 'rates');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/rates

REST Direct URL:


https://api.beepxtra.com/platform/rates

Get Exchange Rates for specific currency

PHP SDK Request:


$beepapi->request('get', 'platform', 'rates/cyp');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/rates/cyp

REST Direct URL:


https://api.beepxtra.com/platform/rates/cyp

categories
Get Sub Category Details
Accepts Parent Category ID

PHP SDK Request:


$beepapi->request('get', 'platform', 'categories/112160');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/categories/112160

REST Direct URL:


https://api.beepxtra.com/platform/categories/112160

currencies
Get all country currencies

PHP SDK Request:


$beepapi->request('get', 'platform', 'currencies');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/currencies

REST Direct URL:


https://api.beepxtra.com/platform/currencies

Get a currency by country id

PHP SDK Request:


$beepapi->request('get', 'platform', 'currencies/3');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/currencies/3

REST Direct URL:


https://api.beepxtra.com/platform/currencies/3

countries
Get all Countries

PHP SDK Request:


$beepapi->request('get', 'platform', 'countries');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/countries

REST Direct URL:


https://api.beepxtra.com/platform/countries

Get a country by id

PHP SDK Request:


$beepapi->request('get', 'platform', 'countries/3');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/countries/3

REST Direct URL:


https://api.beepxtra.com/platform/countries/3

Get countries by Continent


Accepts africa | asia | europe | north america | oceania | south america

PHP SDK Request:


$beepapi->request('get', 'platform', 'countries/europe');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/countries/europe

REST Direct URL:


https://api.beepxtra.com/platform/countries/europe

category
Get Category Details
Accepts Category ID

PHP SDK Request:


$beepapi->request('get', 'platform', 'category/-1');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET https://api.beepxtra.com/platform/category/-1

REST Direct URL:


https://api.beepxtra.com/platform/category/-1

Product Controller
details
Get Product Details
Accepts product ID

PHP SDK Request:


$beepapi->request('get', 'product', 'details/1');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET https://api.beepxtra.com/product/details/1

REST Direct URL:


https://api.beepxtra.com/product/details/1

outlet
Get Outlet Products
Accepts outlet ID

PHP SDK Request:


$beepapi->request('get', 'product', 'outlet/391');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET https://api.beepxtra.com/product/outlet/391

REST Direct URL:


https://api.beepxtra.com/product/outlet/391

store
Get Store Products
Accepts Store ID

PHP SDK Request:


$beepapi->request('get', 'product', 'store/829');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET https://api.beepxtra.com/product/store/829

REST Direct URL:


https://api.beepxtra.com/product/store/829

category
Get Category Products
Accepts Category ID

PHP SDK Request:


$beepapi->request('get', 'product', 'category/3470');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET https://api.beepxtra.com/product/category/3470

REST Direct URL:


https://api.beepxtra.com/product/category/3470

add
Add a new product (Non-existent) to an outlet
accepts parameters as follows:
add/OUTLET_ID/BARCODE:PRODUCT_NAME:PRODUCT_DESCRIPTION:IMAGE:PRICE:DISCOUNT:QUANTITY:REORDER_LEVE
L:DELIVERY_TYPE:WEIGHT:SHIPPING_COST:AVAILABILITY:PROMO_PRICE:PROMO_START_DATE:PROMO_END_DATE:CAT
_ID

PHP SDK Request:


$beepapi->request('post', 'product', 'add/391/12345678:dog shoes:doggy shoes, size 53:image:100.05:2.5:10:2:pickup:0:1:1:0:0:0:77664');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X POST https://api.beepxtra.com/product/add/391/12345678:dog shoes:doggy shoes, size
53:image:100.05:2.5:10:2:pickup:0:1:1:0:0:0:77664

REST Direct URL:


https://api.beepxtra.com/product/add/391/12345678:dog shoes:doggy shoes, size 53:image:100.05:2.5:10:2:pickup:0:1:1:0:0:0:77664

use
Add an existing product to an outlet
accepts parameters as follows:
use/OUTLET_ID/PRODUCT_ID:BARCODE:PRODUCT_NAME:PRODUCT_DESCRIPTION:IMAGE:PRICE:DISCOUNT:QUANTITY:R
EORDER_LEVEL:DELIVERY_TYPE:WEIGHT:SHIPPING_COST:AVAILABILITY:PROMO_PRICE:PROMO_START_DATE:PROMO_E
ND_DATE:CAT_ID

PHP SDK Request:


$beepapi->request('post', 'product', 'use/391/3:12345678:dog shoes:doggy shoes, size 53:image:100.05:2.5:10:2:pickup:0:1:1:0:0:0:77664');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X POST https://api.beepxtra.com/product/use/391/3:12345678:dog shoes:doggy shoes,
size 53:image:100.05:2.5:10:2:pickup:0:1:1:0:0:0:77664

REST Direct URL:


https://api.beepxtra.com/product/use/391/3:12345678:dog shoes:doggy shoes, size 53:image:100.05:2.5:10:2:pickup:0:1:1:0:0:0:77664

change
Update a product for a specific outlet
accepts parameters as follows:
change/OUTLET_ID/PRODUCT_ID:PRODUCT_NAME:PRODUCT_DESCRIPTION:IMAGE:PRICE:DISCOUNT:QUANTITY:REORDE
R_LEVEL:DELIVERY_TYPE:WEIGHT:SHIPPING_COST:AVAILABILITY:PROMO_PRICE:PROMO_START_DATE:PROMO_END_DA
TE

PHP SDK Request:


$beepapi->request('put', 'product', 'change/391/12:dog shoes:doggy shoes:image.jpg:100.25:2.5:10:2:pickup:0:1:1:0:0:0');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X PUT https://api.beepxtra.com/product/change/391/12:dog shoes:doggy
shoes:image.jpg:100.25:2.5:10:2:pickup:0:1:1:0:0:0

REST Direct URL:


https://api.beepxtra.com/product/change/391/12:dog shoes:doggy shoes:image.jpg:100.25:2.5:10:2:pickup:0:1:1:0:0:0

outlet
Delete a product from an outlet
Accepts numeric outlet ID and product ID

PHP SDK Request:


$beepapi->request('delete', 'product', 'outlet/391/product/3');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X DELETE https://api.beepxtra.com/product/outlet/391/product/3

REST Direct URL:


https://api.beepxtra.com/product/outlet/391/product/3

Report Controller
users
Get number of registered users

PHP SDK Request:


$beepapi->request('get', 'report', 'users/registered');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET https://api.beepxtra.com/report/users/registered

REST Direct URL:


https://api.beepxtra.com/report/users/registered

Get number of Inactive users

PHP SDK Request:


$beepapi->request('get', 'report', 'users/inactive');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET https://api.beepxtra.com/report/users/inactive

REST Direct URL:


https://api.beepxtra.com/report/users/inactive

Get number of Active Invites

PHP SDK Request:


$beepapi->request('get', 'report', 'users/invites');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET https://api.beepxtra.com/report/users/invites

REST Direct URL:


https://api.beepxtra.com/report/users/invites

Get number of users by country

PHP SDK Request:


$beepapi->request('get', 'report', 'users/usersbycountry');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET https://api.beepxtra.com/report/users/usersbycountry

REST Direct URL:


https://api.beepxtra.com/report/users/usersbycountry

Get number of users Registered This Month

PHP SDK Request:


$beepapi->request('get', 'report', 'users/thismonth');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET https://api.beepxtra.com/report/users/thismonth

REST Direct URL:


https://api.beepxtra.com/report/users/thismonth

Staff Controller
outlet
Get store or outlet active employees
Accepts store/ID or outlet/ID

PHP SDK Request:


$beepapi->request('get', 'staff', 'outlet/391');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/outlet/391

REST Direct URL:


https://api.beepxtra.com/staff/outlet/391

managed
Get outlets managed by User ID
Accepts user ID

PHP SDK Request:


$beepapi->request('get', 'staff', 'managed/54270');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/managed/54270

REST Direct URL:


https://api.beepxtra.com/staff/managed/54270

outlet
Order the results
accepts order-name-asc, order-surname-desc, order-type-asc, order-started-asc

PHP SDK Request:


$beepapi->request('get', 'staff', 'outlet/391/order-default-desc');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/outlet/391/order-default-desc

REST Direct URL:


https://api.beepxtra.com/staff/outlet/391/order-default-desc

Paginate the results


Self Explanatory

PHP SDK Request:


$beepapi->request('get', 'staff', 'outlet/391/limit-0-1');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/outlet/391/limit-0-1

REST Direct URL:


https://api.beepxtra.com/staff/outlet/391/limit-0-1

Order and Paginate Combination usage


Accepts all ordering types of the returned fields in ASC or DESC commands

PHP SDK Request:


$beepapi->request('get', 'staff', 'outlet/391/limit-0-2/order-default-asc');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/outlet/391/limit-0-2/order-default-asc

REST Direct URL:


https://api.beepxtra.com/staff/outlet/391/limit-0-2/order-default-asc

employee
Get outlets the employee has access to
//Accepts user_id or email

PHP SDK Request:


$beepapi->request('get', 'staff', 'employee/123');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/employee/123

REST Direct URL:


https://api.beepxtra.com/staff/employee/123

Get Employee Permissions for Specific Outlet


Accepts ID or Email for employee

PHP SDK Request:


$beepapi->request('get', 'staff', 'employee/54397/permissions/391');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET https://api.beepxtra.com/staff/employee/54397/permissions/391

REST Direct URL:


https://api.beepxtra.com/staff/employee/54397/permissions/391

OUTLETID
Add new employee to outlet/store
accepts parameters as follows: OUTLET_ID/USER_EMAIL_OR_ID/USER_TYPE

PHP SDK Request:


$beepapi->request('post', 'staff', '391/aaaaa@email.com/3');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X POST https://api.beepxtra.com/staff/391/aaaaa@email.com/3

REST Direct URL:


https://api.beepxtra.com/staff/391/aaaaa@email.com/3

Update an existing employee position


accepts parameters as follows: OUTLET_ID/USER_EMAIL_OR_ID/USER_TYPE

PHP SDK Request:


$beepapi->request('put', 'staff', '391/aaaaa@email.com/3');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X PUT https://api.beepxtra.com/staff/391/aaaaa@email.com/3

REST Direct URL:


https://api.beepxtra.com/staff/391/aaaaa@email.com/3

Remove an existing employee position


accepts parameters as follows: OUTLET_ID/USER_EMAIL_OR_ID/USER_TYPE (All must match)

PHP SDK Request:


$beepapi->request('delete', 'staff', '391/aaaaa@email.com/3');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X DELETE https://api.beepxtra.com/staff/391/aaaaa@email.com/3

REST Direct URL:


https://api.beepxtra.com/staff/391/aaaaa@email.com/3

Store Controller
authenticate
authenticate employee login
accepts parameters as follows: authenticate/OUTLET_ID/USER_EMAIL/USER_PASSWORD it will return the
user details if successful or error

PHP SDK Request:


$beepapi->request('get', 'store', 'authenticate/391/aaaaa@eemail.com/12345678');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|store" -X GET https://api.beepxtra.com/store/authenticate/391/aaaaa@email.com/12345678

REST Direct URL:


https://api.beepxtra.com/store/authenticate/391/aaaaa@email.com/12345678

user Controller
Get user details
Accepts id | email

PHP SDK Request:


$beepapi->request('get', 'user', '13');

CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|user" -X GET https://api.beepxtra.com/user/13

REST Direct URL:


https://api.beepxtra.com/user/13

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy