NAV
javascript

Introduction

Welcome to the generated API reference.

Do you use Postman? Great.
Get Postman Collection
Get Postman Environment

Header

Header Value When should I send?
Accept application/json All requests
Content-Type application/x-www-form-urlencoded Must send when passing query string in request body
Content-Type application/json Must send when passing json in request body
Content-Type multipart/form-data Must send when passing files in request body
Authorization Bearer access_token Whenever the resource requires an authenticated user
Language language All requests

Controlling requests

All API requests are limited to prevent abuse and ensure stability.
The limit is usually 120 requests every 1 minute. But each route can have its own limit.
You can always check the response header to have a status of available requests:

X-RateLimit-Limit → 120
X-RateLimit-Remaining → 25

Errors

API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request sucks
401 Unauthorized -- Your API key is wrong
403 Forbidden -- You are not authorized or do not have permission to access
404 Not Found -- The specified page can not be found
405 Method Not Allowed -- Method not allowed for this request
406 Not Acceptable -- You have requested a format that is not valid
410 Gone -- The target resource is no longer available
413 Payload Too Large -- Request payload is larger than the server is willing or able to process
422 Unprocessable Entity -- Validation error, the given data was invalid
429 Too Many Requests -- You have sent too many requests in a certain amount of time ("rate limiting")
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarially offline for maintanance. Please try again later.

Push General

Get all push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-general",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/admin/push-general

Query Parameters

Parameter Type Validation Description
limit integer integer Default: 20 Max: 100
page integer integer
orderBy string string Default: id:asc.
Available fields: id title body scheduled_at send_at created_at
search string string Search in the fields: uuid title body
created_at[0] string string ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1] string string ISO 8601 Y-m-d\TH:i:sP Final date

Create push

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-general",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "title": "Sed cum numquam et non dicta.",
        "body": "Doloremque debitis adipisci sed iure dolor ut ut. Consectetur sed architecto aut eaque officiis.",
        "url": "http:\/\/www.sandoval.com.br\/voluptas-sit-commodi-sunt-inventore-voluptates-ut-sit",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-general

Parameters

Parameter Type Validation Description
title string required|string|max:50
body string required|string|max:100
url string nullable|string|max:191
scheduled_at string nullable|string ISO 8601 Y-m-d\TH:i:sP Future date

Export push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-general/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-general/export

Query Parameters

Parameter Type Validation Description
orderBy string string Default: id:asc.
Available fields: id title body scheduled_at send_at created_at
search string string Search in the fields: uuid title body
created_at[0] string string ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1] string string ISO 8601 Y-m-d\TH:i:sP Final date

Get push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-general/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/admin/push-general/{push}

Remove push

Example request:

const axios = require('axios');

axios({
    "method": "delete",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-general/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/admin/push-general/{push}

Push Group

Get all push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-group",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/admin/push-group

Query Parameters

Parameter Type Validation Description
limit integer integer Default: 20 Max: 100
page integer integer
orderBy string string Default: id:asc.
Available fields: id title body scheduled_at send_at created_at user.name
search string string Search in the fields: uuid title body user.name
created_at[0] string string ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1] string string ISO 8601 Y-m-d\TH:i:sP Final date

Create push

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-group",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "user_id": "b17ce70d-2da8-3878-b623-b5d7bb669975",
        "title": "Asperiores et necessitatibus dolorem eos quia.",
        "body": "Dignissimos possimus repellat et molestias. Nobis et in sint sed quaerat repudiandae consequatur.",
        "url": "http:\/\/www.dacruz.net.br\/laborum-quibusdam-nulla-eum-iste",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-group

Parameters

Parameter Type Validation Description
user_id integer required|uuid Customer user relationship
title string required|string|max:50
body string required|string|max:100
url string nullable|string|max:191
scheduled_at string nullable|string ISO 8601 Y-m-d\TH:i:sP Future date

Export push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-group/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-group/export

Query Parameters

Parameter Type Validation Description
orderBy string string Default: id:asc.
Available fields: id title body scheduled_at send_at created_at user.name
search string string Search in the fields: uuid title body user.name
created_at[0] string string ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1] string string ISO 8601 Y-m-d\TH:i:sP Final date

Get push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-group/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/admin/push-group/{push}

Remove push

Example request:

const axios = require('axios');

axios({
    "method": "delete",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-group/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/admin/push-group/{push}

Push User

Get all push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-user",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/admin/push-user

Query Parameters

Parameter Type Validation Description
limit integer integer Default: 20 Max: 100
page integer integer
orderBy string string Default: id:asc.
Available fields: id title body scheduled_at send_at created_at user.name
search string string Search in the fields: uuid title body user.name
created_at[0] string string ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1] string string ISO 8601 Y-m-d\TH:i:sP Final date

Create push

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-user",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "user_id": "55701fc7-7789-33d8-85c4-cfcd5b2d30f7",
        "title": "Consequatur vel fuga consequatur hic eum.",
        "body": "Dolor iste explicabo id ratione velit. Sint dolorem quidem suscipit unde nulla accusamus in sit.",
        "url": "http:\/\/barreto.com.br\/consequuntur-consequatur-et-deserunt-repellendus",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-user

Parameters

Parameter Type Validation Description
user_id integer required|uuid Customer user relationship
title string required|string|max:50
body string required|string|max:100
url string nullable|string|max:191
scheduled_at string nullable|string ISO 8601 Y-m-d\TH:i:sP Future date

Export push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-user/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-user/export

Query Parameters

Parameter Type Validation Description
orderBy string string Default: id:asc.
Available fields: id title body scheduled_at send_at created_at user.name
search string string Search in the fields: uuid title body user.name
created_at[0] string string ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1] string string ISO 8601 Y-m-d\TH:i:sP Final date

Get push

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-user/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/admin/push-user/{push}

Remove push

Example request:

const axios = require('axios');

axios({
    "method": "delete",
    "url": "https://api.abccmm.com.br/api/v1/admin/push-user/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/admin/push-user/{push}

javascript