Remax Rest API - Version 1.0

Contact: ben@fyclabs.com

Introduction

Getting Started

Welcome to the Remax Mexico Developer's website.

You can authenticate to the API by providing your API key in the HTTP authorization bearer token header.

Remax uses simple token-based authentication. Your API key carries the same privileges as your user account, so be sure to keep it secret!

You can authenticate to the API by providing your API key in the HTTP authorization bearer token header.

Example: Authorization: bearer YOUR_TOKEN
Dev Root Endpoint: https://us-central1-remax-api.cloudfunctions.net/api

Request Access

All API requests must be authenticated and made over HTTPS. To request a token please reach out to developers@remax.com.mx

Building Fetches

When building the options object provide the api with a queryParam of options and include a JSON string with your options.

Method: GET

Example: ?options=

The Options JSON can include the following properties:
Filter
Type: { [key]:[string | number] }

A key value pair that tells the api to filter the records

Example :
"filter": {
"archivado": 0
}
Order

An array of order by statements. The first element in the array provides the field while the second provides the direction.

"order": [
["fecha_inicio", "DESC"],
["oficina_id", "ASC"]
]
Limit

An integer for limiting the number of records. Max number of records is 1000

"limit": 1000
Offset

An integer for setting the offset

"offset": 1001
Putting it all together
{
"filter": {
"archivado": 0
},
"order": [
["fecha_inicio", "DESC"],
["oficina_id", "ASC"]
],
"limit": 1000,
"offset": 1001
}

Building Inserts

...Coming Soon

Building Updates

...Coming Soon

Building Deletes

...Coming Soon

DataTypes

Status Codes

Success Code

200 OK
Request completed successfully.

User error codes

These errors generally indicate a problem on the client side. If you are getting one of these, check your code and the request details.

400 Bad Request
The request encoding is invalid; the request can't be parsed as a valid JSON.

401 Unauthorized
Accessing a protected resource without authorization or with invalid credentials.

403 Forbidden
Accessing a protected resource with API credentials that don't have access to that resource.

404 Not Found
Route or resource is not found. This error is returned when the request hits an undefined route, or if the resource doesn't exist (e.g. has been deleted).

413 Request Entity Too Large
The request exceeded the maximum allowed payload size. You shouldn't encounter this under normal use.

422 Invalid Request
The request data is invalid. This includes most of the base-specific validations. You will receive a detailed error message and code pointing to the exact issue.