Arbox is a cloud-based CRM solution that offers its API to integrate your site with our organization’s information systems.


So, before you begin, here's what you need to know :)

  • The key will be provided to each club by Arbox.

  • Please copy the API key from the “Settings” page > “Club Information”

  • location_box_fk, parameter, will be provided upon request.

  • You can only access the API using HTTP protocol.

Parameter

Description

Appearance

Explanation

apiKey

string

required

A unique key for each club

Body:

Parameter

Description

Appearance

Explanation

first_name

string

required

Lead’s first name

last_name

string

optional

Lead’s last name

phone

string

required

Lead’s contact number

email

string

required

Lead’s contact email

location_box_fk

Int, (location must be connected to box)

required

System number - studio’s place

status_fk

Int (number)

optional

System number - lead’s status at which it will appear after filling out the form.

source_fk

Int (number)

optional

System number -

the landing page from which the lead generated.

comment

string

optional

Any additional parameter can be used here.

allow_sms

Enum = yes, no

optional

Case sensitive (Use lower case)

allow_mailing_list

Enum = yes, no

optional

Case sensitive (Use lower case)

Request sample on Postman

Response

1.2 Successful response sample:

{

"statusCode": 200,

"data": {

"id": 53736,

"first_name": "Ella",

"last_name": "Fish",

"phone": 05239348583

"email": "talky@talk.8200"

}

}

1.3 Error code list

Integer

Name

Description

500

INTERNAL SERVER ERROR

An unexpected server error occurs.

400

INVALID FORM REQUEST

One or more of your form values are not valid

400

INVALID API USER

The user connected with the API is invalid

401

NO API KEY

Please supply an access token

401

INVALID API KEY

Please provide a valid access token

401

NOT UNIQUE API KEY

Issued access token, please contact ARBOX

2. Get Schedule

API URL

https://api.arboxapp.com/index.php/api/v2/schedule

Acceptable request type

Get

2.1 Parameters

Headers:

Parameter

Description

Appearance

Explanation

apiKey

string

required

A unique key for each club

Params:

Parameter

Description

Appearance

Explanation

from

'dd-mm-YYYY'

or

'mm-dd-YYYY'

Required

If Parameter “to” exists then optional

According to time format

to

'dd-mm-YYYY'

or

'mm-dd-YYYY'

Required

If Parameter “from” exists then optional

According to time format

location

Int, (location must be connected to box)

optional

System number - studio’s place

Response

2.2 Successful response sample:

{

statusCode:200,

data: Array({

"coach": “Michael Cohen”,

"secondCoach": “Lora Smith”,

"name": “Yoga for Beginners”,

"startTime": ״14:00:00,

"endTime": “15:00:00”,

"date": ”2020-07-26”,

"liveLink": Live Link to class, if exists,

"isCancelled": false,

"maxMembers": 15,

"location": Tel Aviv,

"isTransparent": false

})}

2.3 Error code list

Integer

Name

Description

415

DATE RANGE EXCEEDS

The date range is greater than 7 days, please limit your request to up to 7 days

500

INTERNAL SERVER ERROR

An unexpected server error occurs.

400

INVALID FORM REQUEST

One or more of your form values are not valid

400

INVALID API USER

The user connected with the API is invalid

401

NO API KEY

Please supply an access token

401

INVALID API KEY

Please provide a valid access token

401

NOT UNIQUE API KEY

Issued access token, please contact ARBOX

3. Use of Login Data

API URL

https://api.arboxapp.com/index.php/api/v2/users/checkActive

Acceptable request type

Post

3.1 Parameters

Headers:

Parameter

Description

Appearance

Explanation

apiKey

string

required

A unique key for each club

Body:

Parameter

Description

Appearance

Explanation

email

string

required

User’s email address

password

string

required

User’s password

Response

3.2 Successful response sample:

{

"statusCode": 200,

"data": {

"isActive": true/false

}

3.3 Error code list

Integer

Name

Description

415

FAILED

one or more of the fields are incorrect or invalid

500

INTERNAL SERVER ERROR

An unexpected server error occurs.

400

INVALID FORM REQUEST

One or more of your form values are not valid

400

INVALID API USER

The user connected with the API is invalid

401

NO API KEY

Please supply an access token

401

INVALID API KEY

Please provide a valid access token

401

NOT UNIQUE API KEY

Issued access token, please contact ARBOX

4. User’s Memberships Data

API URL


https://api.arboxapp.com/index.php/api/v2/users/membershipsData

Acceptable request type

Get

1.1 Parameters

Headers:

Parameter

Description

Appearance

Explanation

apiKey

string

required

apiKey

Body:

Parameter

Description

Appearance

Explanation

userId

String

required

user id

Request sample on Postman

Response

1.2 Successful response sample:

{

"statusCode": 200,

"data": {

"id": 146,

"name": "15 Sessions",

“type”: “plan”,

“price”: “300”,

“sessions_left: 2”,

“start”: “2020-01-01”,

“end”: “2021-01-01”,

“active”: 1,

“cancelled” : 0,

“debt” : 100,

“created_at”: “2020-01-01”

}

}

1.3 Error code list

Integer

Name

Description

500

INTERNAL SERVER ERROR

An unexpected server error occurs.

400

INVALID FORM REQUEST

One or more of your form values are not valid

400

INVALID API USER

The user connected with the API is invalid

401

NO API KEY

Please supply an access token

401

INVALID API KEY

Please provide a valid access token

401

NOT UNIQUE API KEY

Issued access token, please contact ARBOX

Did this answer your question?