Authentication

MPush uses some HTTP headers to handle requests. In particular, are used to authenticate and to know which kind of data should expect from the client and vice versa.

All used headers are shown in the below table, but they can change based on which API you are calling.

Header

Description

Accept

Should always be application/json.

Content-Type

Should always be application/json.

X-MPush-Token

Contains the token to authenticate every API call.

X-MPush-Version

Define the API version you want to use. The minimum and actual is 2.

Errors

MBurger APIs uses the following HTTP error codes:

Code

Meaning

Description

400

Bad Request

Your request is invalid.

401

Unauthorized

Your API key is wrong or not present.

403

Forbidden

You don't have permission to access this resource.

404

Not Found

The requested resource can not be found.

405

Method Not Allowed

You tried to use an invalid method.

406

Not Acceptable

You requested a format that isn't json.

422

Unprocessable Entity

You requested did not pass the input validation.

429

Too Many Requests

You're requesting too many! Slow down!

500

Internal Server Error

We had a problem with our server. Try again later.

503

Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Below are reported some examples of them:

On authentication error is returned an HTTP 401 and a JSON like this:

{
"message": "The project token is not present."
}

On permission error is returned an HTTP 403 and a JSON like this:

{
"message": "This action is unauthorized."
}

On validation error is returned an HTTP 422 and a JSON like this:

{
"message": "The given data was invalid.",
"errors": {
"email": [
"The token field is required."
]
}
}