Notificacoes Inteligentes (0.1.0)

Download OpenAPI specification:Download

Email para contato: [email protected]

Email para suporte: [email protected]

API do Notificações Inteligentes para controle das integrações.

Autorização & Autenticação

A autenticação é realizada através do método Bearer Token, utilizando a chave de API do usuário. Para mais detalhes sobre a chave de API acesse nossa documentação

Toda requisição precisa ter o header Accept:

  Accept: application/json

Para mais detalhes sobre os eventos da API, assista o video abaixo ou clique aqui

Como sei que deu certo?

Acompanhe a tela de estatísticas da sua integração. Nela, temos todos os envios diários.

Caso não saiba onde fica essa tela, acesse este artigo para saber como verificar as estatísticas.

Já fiz tudo, e agora?

Se não houver nenhum envio depois de um tempo, verifique se a sua integração está conectada a uma instância.

Recomendamos que você:

  1. NÃO tente testar manualmente os webhooks da integração. A operação pode causar grandes problemas caso passe algum telefone incorreto ou com falta de dados;
  2. NÃO tente enviar uma notificação para o mesmo número de telefone que faz os envios. A operação não dá certo, ok?

Teste de endpoint

Sempre que for fazer algum teste utilizando nossos endpoints, recomendamos que altere os valores do Request Body em cada requisição para evitar problemas, pois, não repetimos os payloads.

Too Many Requests

As rotas de eventos das integrações podem receber, no máximo, 10 mil requisições a cada dez minutos ou 100 mil requisições por dia

Padrões de datas da API

Em nossa API existem duas formas de nos fornecer datas:

A primeira forma consiste em nos informar apenas a data Ano-mês-dia, esta forma deve ser usada nos eventos relacionados a Rastreio e Boletos, lembrando que mesmo sem nos fornecer dados como Hora:minuto:segundos, esta data deve estar em Timezone UTC +0

  "created_at": "2020-03-10"

A segunda forma consiste em nos informar a data e o horário Ano-mês-dia Hora:minuto:segundo, esta forma deve ser usada nos demais eventos que utilizam datas, lembrando que esta data e horário devem estar em Timezone UTC +0

  "created_at": "2020-03-10 13:26:57"

Opt-out

Ao criar um Opt-Out, o sistema buscará todas as instâncias em comum com as lojas conectadas na instância atual e aplicará o bloqueio do contato em todas elas.

Authentication

bearer_token

Token de autenticação da API no formato Bearer

Security Scheme Type API Key
parameter name: Authorization

Gerenciamento da conta

Busca endereço

Busca os dados do endereço através do CEP fornecido

Authorizations:
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
CEP
string

Responses

Request samples

Content type
application/json
{
  • "CEP": "32600-100"
}

Response samples

Content type
application/json
{
  • "address": "string"
}

Gerenciamento de Integrações

Lista integrações

Lista todas as integrações

Authorizations:
header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria integração

Cria uma nova integração com os dados fornecidos

Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
required
string <= 100 characters

Nome da integração para identificação no painel

platform
required
string (Platform)
Enum: "abmex" "active-campaign" "api-next" "app-max" "asaas" "bling" "braavo" "braip" "brasil-na-web" "builder-all" "calendly" "cartpanda" "climba" "cloudfox" "convertize" "convertpack" "convvert" "digital-manager-guru" "dinamize" "dooca" "doppus" "eduzz-2" "evermart" "evipes" "e-com-plus" "e-goi" "find-my-pack-next" "galax-pay" "greenn" "hero-spark" "hopy" "hotmart" "hubspot" "infusionsoft" "irroba" "iset-2" "iugu" "jet" "kapsula" "kiwify-2" "lead-lovers" "lpqv" "loja-integrada" "magento" "mautic" "member-kit" "monetizze-2" "moovin" "notazz" "octapay" "pagali" "pagar-me-1" "pagar-me-2" "pag-hiper" "payt" "perfect-pay" "prestashop" "rd-station" "saiu-pra-entrega" "shopify-next" "shoppub" "simplo-7" "stripe" "thrivecart" "ticto-2" "tiny" "track-co" "tray" "tray-corp" "tryplo" "upnid" "via-shop-moda" "vindi" "vnda" "vtex" "wapstore" "wbuy" "woocommerce" "woocommerce-cart-abandonment-recovery" "yampi" "yapay"

Plataforma da integração

Responses

Request samples

Content type
application/json
{
  • "name": "Loja de Doces",
  • "platform": "abmex"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza integração

Permite a atualização de informações da integração

Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
string <= 100 characters

Nome da integração para identificação no painel

Responses

Request samples

Content type
application/json
{
  • "name": "Loja de Doces"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}