Introduction

Welcome to the Raixer API, a HTTP-based RESTful API that uses HTTP Basic Auth for authorization and has all request and response bodies formatted in JSON. You can use our API to interact with our entire platform and, specially, to interact with our awesome Raixer devices.

We have several language bindings! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

We use HTTP Basic Auth to allow access to our API. Please, contact us at hello@raixer.com to get one. While you get your credentials from us, please, register on our great App and configure your devices, so you can use them.

We expect your private API username and password to be included as an Authorization Header in all of the requests you make. In, more or less words, this is:

Make a string of this form: your_api_username:your_api_password

Encode the obtained string in base 64

Put the encoded string in an HTTP Header called Authorization with the value Basic your_encoded_base64_string

You must replace your_api_username and your_api_password with your personal values.
If you're having problem getting your encoded base 64 string to work, maybe you're not encoding it right. We recommend using Postman to generate your encoded string and try a sample request before.

Authorized Phones

To allow a specific phone number, from all around the world, access to a device, you create an authorized phone. The API allows you to create, update or delete an authorized phone. You can retrieve an individual phone as well as list all of them associated to a device. Authorized phones are identified by a unique, random ID.

To control a specific device, no matter where it is, you must have a connection. The API allows you to create, update or delete a connection in multiple ways. You can retrieve an individual connection as well as list all of them associated to a user, ordered or not. Connections are identified by a unique, random ID and are always associated to an user and a device.

HTTP Request

POST https://api.raixer.com/connections

Body Parameters

Parameter

Required

Default

Description

deviceId

Yes

N/A

A string that specifies the device associated to the connection.

profile

No

N/A

A string that specifies the level of control given to the owner of the connection for the associated device. Must be one of the following: 'user', 'admin', 'installer'. If not specified, the resulting profile will depend of the passing or not of the deviceOwner parameter.

disabled

No

N/A

A boolean that specifies if the connection is disabled or not.

name

No

N/A

A string that specifies the name you want to the connection.

deviceOwer

No

N/A

A string that specifies the owner of the device associated to the connection. If not passed (and the profile is not passed also), the profile of the connection will be 'admin'. If passed (and the profile is passed also), the profile of the connection will 'admin' if the parameter value is the same as the ID of the user making the request, if not, it will be 'user'. If this parameter is not passed, the device will be updated to change its owner to the user making this request.

The section you must be most excited to read and to play with: our awesome Raixer Devices :). Let's be honest, our devices are the reason you know us and use Raixer in the first place. Here, you will learn to use our API to manage, configure and interact with all your devices without interacting throughout our APP, in most cases. Devices are identified by a unique ID that comes directly configured from the factory and into their firmware.

It is very important that you are either the owner or an authorized user (have a connection to the device) of the device you want to interact with, because, for very important security reasons, we don't allow unauthorized use of the devices.

IMPORTANT NOTE:

If you want to see the addresses or all of the properties your devices are controlling, you must follow the [Connections](#connections) section of our API, after you identify the device controlling a certain property, you can then follow this section to do whatever you want with your device.

Create a Device

To create a new device you must use our APP and configure it through the ADD button on the Main Screen, afterwards, follow the instructions of the Configure new device process. This will guide you through the WiFi or Mobile connection configuration for the device, so it can have internet and be interacted with. If you want, you can also make the configuration and calibration of the sensors, if applies.

We highly recommend that all of this process is made by an installer, so you can be sure that your device is configured correctly and will function accordingly.

Deletes a device (well, to be honest, it only removes the IDs of the owner and the campaign from a device, we never delete them :)) and all the data associated to it, as it's users connections and it's sensors for doors or other use.

Retrieves all the information of a device. The most interesting parts of this information are the variables and the functions, wich, respectively, represents all the variables and functions made available by or to the device.

HTTP Request

GET https://api.raixer.com/devices/:id/information

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device to retrieve the information

Retrieves a device vitals, regarding the signal and power (if the device has the possibility to connect a battery and it has one connected).

HTTP Request

GET https://api.raixer.com/devices/:id/vitals

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device to retrieve the vitals

Power index

The power index of the response is present if the device has the possibility to connect a battery and it has one connected. If this index
is present, it has a battery index, with the state of the battery and the charge of it.

The charge index is a number between 0-100, indicating the percentage of charge of the connected battery.

Signal index

The signal index of the response is always present, regarding the device is an Intercom or an Access. This object describes several things regarding
the signal (WiFi for Intercoms and 2G/3G for Access) the device is capturing.

The strength index is a number between 0-100, indicating the percentage of strength of the signal.

The quality index is a number between 0-100, indicating the percentage of quality of the signal.

The rssi index is a number, it's values are explained in the table below. Keep in mind the following table is just for reference and the values for RSSI changes depending of the type of connection of the device (WiFi or 2G/3G/4G/LTE). We would love to explain these values deeply but, sadly, because we are not telecom. experts, we can't :(; so, if you want more information of this values, please, feel free to look in the internet.

RSSI Value

Meaning

> -70

Excellent signal strength (closer to 0 is better)

-70 to -85

Good signal strength

-86 to -100

Fair signal strength

< -100

Poor signal strength

-110

No signal

Important notes

The intercom devices does not return a power index, because they don't have the possibility of connecting a battery.

Retrieves a the value of a variable of the device. The variable must be listed in the variables section of the information of the device.

The result of the variable will always be in the field result.

HTTP Request

GET https://api.raixer.com/devices/:id/variable/:variable

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device to retrieve the variable

variable

Yes

N/A

A string that specifies the name of the variable to retrieve

Practical example

Imagine you need to know if the device is in listening mode (auto access) in this particular moment, you'll need then to call this endpoint with the variable status or statusN (where N is the number of the port to get the info of, starting at 2), depending of the port you'll want to check.

The result of this variable is always a string separated by commas and it always has 6 parts, no matter if some are empty. The parts of the string represent the following:

Position

Type

Possible values

Meaning

0

Number

1 or 0

The device is in listening mode or not (1 for listening, 0 for not listening)

1

String

N/A

The ID of the last user that put the device in listening mode. Empty if the device is not in listening mode.

2

Date and time (timestamp)

N/A

The date and time (in a timestamp) that specifies when the device was put in listening mode or not (0 for when it is not in listening mode)

3

Date and time (timestamp)

N/A

The date and time (in a timestamp) for when the device was last turned on

4

Number

1 or 0

The device is an intercom device or not (1 is an intercom device, 0 not)

5

Number

N/A

A number that indicates how many auto openings the device has made (f.e. somebody called the door) since it was last put in listening mode (auto access)

List of Available Variables

Below you'll find a list of all the available device variables and their meaning. Please, note that not every variable is available for all device types, so, make sure to know the version and type of your Raixer Device before trying to get a variable.

Name

Type

Device Type

Possible values

Meaning

connected

Number

All

1

The device is connected and running

status

String

All

See section above

See section above

status2

String

Intercom Two Doors and Access

Same as status (See section above)

Same as status (See section above) but for the door connected to the door sensor port 2.

buzzerValue

Number

All

Number >= 0

The value in [mV] detected by the device for the door sensor port 1.

buzzerValue2

Number

Intercom Two Doors and Access

Number >= 0

The value in [mV] detected by the device for the door sensor port 2.

openValue

Number

All

Number >= 0

The target value in [mV] for the device to open the door connected to the door sensor port 1.

openValue2

Number

Intercom Two Doors and Access

Number >= 0

The target value in [mV] for the device to open the door connected to the door sensor port 2.

tolerance

Number

All

Number >= 0

A value in [mV] that indicates that the device will open the door connected to the door sensor port 1 when it detects a value between openValue - tolerance and openValue + tolerance

tolerance2

Number

Intercom Two Doors and Access

Number >= 0

A value in [mV] that indicates that the device will open the door connected to the door sensor port 2 when it detects a value between openValue2 - tolerance and openValue + tolerance

sensorMode

Number

All

-1, 0 or 1

The mode in which the door sensor port 1 is functioning, -1 or 0 to bell sensor (for an intercom sensor) or 1 for opening sensor.

sensorMode2

Number

Intercom Two Doors and Access

-1, 0 or 1

The mode in which the door sensor port 2 is functioning, -1 or 0 to bell sensor (for an intercom sensor) or 1 for opening sensor.

doorIsOpen

Number

Intercom One Door and Intercom Two Doors

1 or 0

Indicates if the door connected to the door sensor port 1 is open or not. This will only function correctly if the device has an open/closed sensor connected to the port. We recommend to not get this value directly because, depending of the sensor, the value for open or close could be inverted.

doorIsOpen2

Number

Intercom Two Doors

1 or 0

Indicates if the door connected to the door sensor port 2 is open or not. This will only function correctly if the device has an open/closed sensor connected to the port. We recommend to not get this value directly because, depending of the sensor, the value for open or close could be inverted.

doorIsOpen3

Number

Access

1 or 0

Indicates if the door connected to the door sensor port 3 is open or not. This will only function correctly if the device has an open/closed sensor connected to the port. We recommend to not get this value directly because, depending of the sensor, the value for open or close could be inverted.

movement

Number

Intercom Two Doors and Access

1 or 0

Indicates if the movement sensor connected to any of the ports is detecting movement or not (1 for movement, 0 for none). This will only function correctly if the device has a movement sensor connected to any port.

Execute a function of the device. The function must be listed in the functions section of the information of the device.

HTTP Request

POST https://api.raixer.com/devices/:id/function/:function

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device to retrieve the variable

function

Yes

N/A

A string that specifies the name of the function to execute

List of Available Functions

Below you'll find a list of all the available device functions and their meaning. Please, note that not every variable is available for all device types, so, make sure to know the version and type of your Raixer Device before trying execute a function. Also, on a more important note, some functions are not recommended to use by calling them directly, as they are intended to use through our corresponding API functions or our APP.

Name

Deprecated

Recommended use

Device Type

Argument

Possible return values

Meaning

relay

NO

API

All

See related section below

1 or 0

This function starts the Auto Access for the sensor connected to the door sensor port 1. If it returns 1, it started correctly, if 0, it did not start correctly.

relay2

NO

API

Intercom Two Doors and Access

See related section below

1 or 0

This function starts the Auto Access for the sensor connected to the door sensor port 2. If it returns 1, it started correctly, if 0, it did not start correctly.

solenoid

YES

None

All

None

1

Starts the solenoid corresponding to the door sensor port 1.

cut

NO

API

All

None

1

This function stops the Auto Access for the sensor connected to the door sensor port 1.

cut2

NO

API

Intercom Two Doors and Access

None

1

This function stops the Auto Access for the sensor connected to the door sensor port 2.

state

YES

None

All

None

1

Always returns 1, it is called to see if the device is online and running.

add

YES

None

All

Number

1 or 0

This function add the passed time to the Auto Access for the sensor connected to the door sensor port 1. It returns 1 if everything was ok, 0 for when it is not.

intercom

YES

None

All

None

1 or 0

Indicates if the device is a Power Device or not: 0 for when it is and 1 for when it is not.

openDoor

NO

API

All

None

1

Opens the door connected to the door sensor port 1.

openDoor2

NO

API

Intercom Two Doors and Access

None

1

Opens the door connected to the door sensor port 2.

openDoor3

NO

API

Access

None

1

Opens the door connected to the door sensor port 3.

calibrate

NO

APP

All

None

Number >= 0

Starts the process of auto calibration. Resets all the values associated to the process of auto calibration for the sensor connected to the door sensor port 1. It returns the number of seconds the device will calculate the mean of the buzzer value for the port 1 when it is in resting state. Use it only from our APP.

calibrate2

NO

APP

Intercom Two Doors and Access

None

Number >= 0

Starts the process of auto calibration. Resets all the values associated to the process of auto calibration for the sensor connected to the door sensor port 2. It returns the number of seconds the device will calculate the mean of the buzzer value for the port 2 when it is in resting state. Use it only from our APP.

getRestMean

NO

APP

All

None

Number >= 0

Part to the process of auto calibration. Gets the mean of the buzzer value for the door connected to the door sensor port 1, for it's resting state, calculated after calling the function calibrate. Use it only from our APP.

getRestMean2

NO

APP

Intercom Two Doors and Access

None

Number >= 0

Part to the process of auto calibration. Gets the mean of the buzzer value for the door connected to the door sensor port 2, for it's resting state, calculated after calling the function calibrate2. Use it only from our APP.

getMean

NO

APP

All

None

Number >= 0

Part to the process of auto calibration. Gets the mean of the buzzer value for the door connected to the door sensor port 1, calculated after calling the function calibrate and getRestMean. Use it only from our APP.

getMean2

NO

APP

Intercom Two Doors and Access

None

Number >= 0

Part to the process of auto calibration. Gets the mean of the buzzer value for the door connected to the door sensor port 2, calculated after calling the function calibrate2 and getRestMean2. Use it only from our APP.

getTol

NO

APP

All

None

Number >= 0

Part to the process of auto calibration. Gets the tolerance for the buzzer value for the door connected to the door sensor port 1, calculated after calling the function calibrate, getRestMean and getMean. Use it only from our APP.

getTol2

NO

APP

Intercom Two Doors and Access

None

Number >= 0

Part to the process of auto calibration. Gets the tolerance for the buzzer value for the door connected to the door sensor port 2, calculated after calling the function calibrate2, getRestMean2 and getMean2. Use it only from our APP.

setValues

NO

None

All

See related section below

1

Sets the values of the variables openValue, tolerance, maxOpenings, waitTimeFirst and sensorMode.

setValues2

NO

None

Intercom Two Doors and Access

See related section below

1

Sets the values of the variables openValue2, tolerance2, maxOpenings2, waitTimeFirst2 and sensorMode2.

activate

NO

None

Access

1 or 0

1 or 0

Activates or deactivates the whole system controlling the open/close mechanism of the door connected to the middle port (port 3) of the Access device. If the argument is 1, the mechanism will activate (will work as normal), if it's 0 it will deactivate the mechanism (will always be open). Returns 1 for when the mechanism is active and 0 for when it's not. DO NOT USE DIRECTLY, as it is intended to work automatically when the device loses its internet connection.

changeMode

NO

None

Access

None

1

WORK IN PROGRESS: Activates or deactivates the whole system controlling the failsafe system of the open/close mechanism of the door connected to any of the ports of the device.

lastMove

NO

API or Direct

Intercom Two Doors and Access

None

Timestamp in UTC or 0

Indicates the date and time of the last movement detected by the movement sensor connected to any of the ports of the device. If it returns 0, indicates that there are no new movement.

alarm

NO

API or Direct

Intercom Two Doors and Access

1, 0 or infinite

1 or 0

Activates or deactivates the "movement alarm" system of the device, sending a maximum of 3 notifications (if parameter was 1) or sending infinite notifications (if parameter was infinite) when the device detects movement when the system is active. Returns 1 for when the system was activated or 0 for when it's not.

offlineAA

NO

APP, API or Direct

All

1 or 0

1 or 0

Activates or deactivates the "Offline Auto Access" Contingency Mode of the device, wich starts the Auto Access whenever the device goes offline. Returns 1 for when the mode was activated or 0 for when it's not.

alwaysActive

NO

APP, API or Direct

All

1 or 0

1 or 0

Activates or deactivates the "Auto Access Always Active" Mode of the device, wich sets the Auto Access on for all time for all the configured door sensor ports. Returns 1 for when the mode was activated or 0 for when it's not.

resetMemory

NO

None

All

None

1

Resets the device memory to it's factory state. WARNING: calling this function will delete all the stored values in the device wich may lead to undesired behavior and wrongly executed openings for Auto Access Mode.

invertSensor

NO

API or Direct

Intercom Two Doors and Access

1 or 0

1 or 0

Indicates wether the device has to interpret the readings from a connected movement sensor as inverse or not. If the argument is 1, the sensor will be interpreted as inverted, 0 as normal. Returns 1 if the sensor will be interpreted as inverted, 0 for when it's not.

waitBells

NO

API or Direct

All

1 or 0

1 or 0

Sets the time, in seconds, the device will wait after detecting a bell ring to detect a new one, eliminating the problem of detecting further bell rings one after another. This value is only considerated when the device has its Auto Access mode active for the door sensor port 1.

waitBells2

NO

API or Direct

Intercom Two Doors and Access

1 or 0

1 or 0

Sets the time, in seconds, the device will wait after detecting a bell ring to detect a new one, eliminating the problem of detecting further bell rings one after another. This value is only considerated when the device has its Auto Access mode active for the door sensor port 2.

Relay Functions Argument

These functions expect a string argument of certain numbers separated by commas. In the table below you'll find the explanation of all the parts.

Position

Required

Type

Possible values

Meaning

0

Yes

Number

Number >= 0

Value indicating how much time the device will be in Auto Access mode for the corresponding port.

1

No

String

String or empty

The ID of the user who started the Auto Access Mode.

2

Yes (Intercom One Door and Intercom Two Doors) / No (Access)

Number

Number >= 0 or Empty

Value for the corresponding openValue variable.

3

Yes (Intercom One Door and Intercom Two Doors) / No (Access)

Number

Number >= 0 or Empty

Value for the corresponding tolerance variable.

4

Yes (Intercom One Door and Intercom Two Doors) / No (Access)

Number

Number >= 0 or Empty

Value for the corresponding maxOpenings variable.

5

Yes (Intercom One Door and Intercom Two Doors) / No (Access)

Number

Number >= 0 or Empty

Value for the corresponding waitTimeFirst variable.

SetValues Functions Argument

These functions expect a string argument of certain numbers separated by commas. In the table below you'll find the explanation of all the parts.

Position

Type

Possible values

Meaning

0

Number

Number >= 0

Value for the corresponding openValue variable.

1

Number

Number >= 0

Value for the corresponding tolerance variable.

2

Number

Number >= 0

Value for the corresponding maxOpenings variable.

3

Number

Number >= 0

Value for the corresponding waitTimeFirst variable.

4

Number

0, 1 or 2

Value indicating the sensorMode of the door, 0 for when it is an Auto Access, 1 for when it is an Opening Sensor or 2 for anything else.

5

Number

0 or 1

Value indicating the sensorReverse of an Opening Sensor door, dictating if the sensor has the readings inverse of the expected.

6

Number

Number >= 0

Value for the corresponding waitBuzzerTime variable, wich indicates how many seconds the bell has to be pressed before the device recognises the calling and opens the door. This value is only for an Auto Access door.

Opens the door connected to the sensor of the device at the position or use specified.

This method, in difference with Open door, returns an array, with the result of the operation for each of the doors that were selected by the user specified position/use. For example: a device has configured two doors for the use street, this method will return an array with two objects indicating the result of the operation for each of the doors.

HTTP Request

POST https://api.raixer.com/devices/:id/open-door/:position

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

position

Yes

N/A

A number or string that specifies the position or the use of the sensor you want to open. If it is a number it should be 1 or higher. If it is a string, it should be one of the following: street, home, garage or other.

Important notes

Old intercom devices (version 1), will always open the door at position 1, because they don't have more than one port.

If you have a new intercom device (version 2 or higher), with more than one port, we highly recommend to configure it's doors (sensors) through our APP to be able to use this function accordingly. The posisitons or uses you specify to each door in our APP corresponds to the positions you specify in this function.

Starts the auto access listening mode in the door connected to the door of the device at the position or use you specify. If a device is in auto access listening mode, whenever somebody calls the bell of the door or the intercom connected to that sensor, the device will get the call and open the door.

This method, in difference with Start Job, returns an array, with the result of the operation for each of the doors that were selected by the user specified position/use. For example: a device has configured two doors for the use street, this method will return an array with two objects indicating the result of the operation for each of the doors.

Important notes

Old intercom devices (version 1), will always start the auto access listening mode at position 1, because they don't have more than one port.

If you have a new intercom device (version 2 or higher), with more than one port, we highly recommend to configure it's doors (sensors) through our APP to be able to use this function accordingly. The posisitons or uses you specify to each door in our APP corresponds to the positions you specify in this function.

HTTP Request

POST https://api.raixer.com/devices/:id/start-job/:position

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

position

Yes

N/A

A number or string that specifies the position or the use of the sensor you want to open. If it is a number it should be 1 or higher. If it is a string, it should be one of the following: street, home, garage or other.

Body Parameters

Parameter

Required

Default

Description

minutes

Yes

N/A

A number that specifies the number of minutes the device will be in auto access listening mode.

openingValue

No

Configured value

A number that specifies the value (in Volts) in which the sensor will react. If not passed, the device will take the previously configured value via our APP.

tolerance

No

Configured value

A number that specifies the value (in Volts) to add/remove to the openingValue to define the range in which the sensor will react. If not passed, the device will take the previously configured value via our APP.

maxOpenings

No

Configured value

A number that specifies the maximum number of auto openings allowed by the device in listening mode before it is automatically ended. If not passed, the device will take the previously configured value via our APP.

waitTimeFirst

No

Configured value

A number that specifies the amount of time in seconds the device will wait before opening the door when it is informed to do it (via the API, APP or Phone call). If not passed, the device will take the previously configured value via our APP.

Stops the auto access listening mode for the door connected to the sensor of the device at the position or use specified.

This method, in difference with Stop job, returns an array, with the result of the operation for each of the doors that were selected by the user specified position/use. For example: a device has configured two doors for the use street, this method will return an array with two objects indicating the result of the operation for each of the doors.

HTTP Request

POST https://api.raixer.com/devices/:id/stop-job/:position

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

position

Yes

N/A

A number or string that specifies the position or the use of the sensor you want to open. If it is a number it should be 1 or higher. If it is a string, it should be one of the following: street, home, garage or other.

Important notes

Old intercom devices (version 1), will always stop the auto access listening mode at position 1, because they don't have more than one port.

If you have a new intercom device (version 2 or higher), with more than one port, we highly recommend to configure it's doors (sensors) through our APP to be able to use this function accordingly. The posisitons or uses you specify to each door in our APP corresponds to the positions you specify in this function.

Enables or disables the Offline Auto Access Contingency Mode of the device. If this mode is active for a device, when it goes offline it will start automatically it's Auto Access Mode as long as it's offline or the maximum number of openings are reached.

HTTP Request

POST https://api.raixer.com/devices/:id/offline-auto-access

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

Body Parameters

Parameter

Required

Default

Description

offlineAutoAccess

Yes

N/A

A boolean (true/false) that specifies if the Offline Auto Access will be active or not.

Importat notes

This functionality is only available if your device has our latest firmware. Don't worry, your device should already have it as we update all of our devices automatically.

If, by any reason, calling this function returns you an error, please, contact us so we can update the firmware of your device.

Enables or disables the Auto Access Always Active Mode of the device. If this mode is active for a device, the configured sensors door ports will always be in Auto Access mode, doesn't matter the device goes offline or the maximum number of openings are reached.

HTTP Request

POST https://api.raixer.com/devices/:id/auto-access-always-active

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

Body Parameters

Parameter

Required

Default

Description

autoAccessAlwaysActive

Yes

N/A

A boolean (true/false) that specifies if the Offline Auto Access will be active or not.

Importat notes

This functionality is only available if your device has our latest firmware. Don't worry, your device should already have it as we update all of our devices automatically.

If, by any reason, calling this function returns you an error, please, contact us so we can update the firmware of your device.

Starts the auto access listening mode in the door connected to the first sensor door port of the device. If a device is in auto access listening mode, whenever somebody calls the bell of the door or the intercom, the device will get the call and open the door.

Importat note

DEPRECATED: we strongly recommend to instead use the Start Job at position.

HTTP Request

POST https://api.raixer.com/devices/:id/start-job

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

Body Parameters

Parameter

Required

Default

Description

minutes

Yes

N/A

A number that specifies the number of minutes the device will be in auto access listening mode.

openingValue

No

Configured value

A number that specifies the value (in Volts) in which the sensor will react. If not passed, the device will take the previously configured value via our APP.

tolerance

No

Configured value

A number that specifies the value (in Volts) to add/remove to the openingValue to define the range in which the sensor will react. If not passed, the device will take the previously configured value via our APP.

maxOpenings

No

Configured value

A number that specifies the maximum number of auto openings allowed by the device in listening mode before it is automatically ended. If not passed, the device will take the previously configured value via our APP.

waitTimeFirst

No

Configured value

A number that specifies the amount of time in seconds the device will wait before opening the door when it is informed to do it (via the API, APP or Phone call). If not passed, the device will take the previously configured value via our APP.

Stops the auto access listening mode for the door connected to the first sensor door port of the device.

Importat note

DEPRECATED: we strongly recommend to instead use the Stop Job at position.

HTTP Request

POST https://api.raixer.com/devices/:id/stop-job

Parameters

Parameter

Required

Default

Description

id

Yes

N/A

A string that specifies the ID of the device

Device Upgrades

When you acquire a Raixer Device you have 7 days to interact and test with it without paying us anything. After your 7 dayas has passed, you'll have to Upgrade your Device so you can keep using it.

To manage your Devices Upgrades you can only use our awesome Raixer APP :) To do it, go into the detail screen of the device you want to Upgrade and then into the Settings Screen of it, once you're there, search for the Upgrade section and follow the two simple steps. After you upgrade your device, you can use as you want with our API.

To give you a heads up, we offer two awesome plans to better suit your needs and wallet: monthly and yearly.

To mantain certain data and traceability to our intercom devices, we have campaigns. The API allows you to retrieve an individual campaign as well as list all of them associated to your user. Intercom campaigns are identified by a unique, random ID.

To mantain certain data and traceability to our power devices, we have campaigns. The API allows you to retrieve an individual campaign as well as list all of them associated to your user. Power campaigns are identified by a unique, random ID.

To allow an intercom device to listen to bell calls and open the door automatically when they happen, you create a schedule. The API allows you to create, update or delete a schedule. You can retrieve an individual schedule as well as list all of them or list all of them associated to a campaign. Schedules are identified by a unique, random ID.

To allow you to interact with our entire platform, through our APP or API, you must have an user. The API allows you only to update a user and to retrieve an individual one. Users are identified by a unique, random ID.

Create a User

To create a user you must register on our APP via Email and Password or Facebook, it will only take you a minute and you will love all the great things you can do with our awesome platform.