Skip to main content

API de Integração

API de Integração

As (API), Interfaces de programação das aplicações tem padrões de relacionamento  através de rotinas pré estabelecidas dentro da suite discador O Token é gerado a partir da configuração e as regras das  ações de relacionamento estão disponíveis no arquivo de documentação da API, com cesso através do botão ver documentação.

Recursos de programação

  1. Inserir o Nome do Usuário
  2. Clicar no botão Gerar Token, o código é exibido na janela aberta e o usuário aparece na lista com Tokens e o último acesso.

Documentação da API

URL da documentação Swagger: https://pabx.vya.digital/suite/api_doc.php#/

  • Autenticação para os Endpoints

URL: https://pabx.vya.digital/suite/api

usuario: api-vya-digital

token: 81a0998e-ac08-4c83-a2ed-523ab330f5f8

 

Importação de Mailing por API

Para realizar a carga do mailing, precisamos precisamos tem em mão o ID do cliente e o ID da campanha. Segue a sequência dos endpoints para coleta desses dados.

    1.

  1. listar_clientes_v2
(GET)

Lista as empresas para coletar o "cliente_id"

image.png

É possível filtrar pelo nome da Empresa preenchendo o parâmetro "nome"

image.png

2. listar_campanhas (GET)

Utilize o "cliente_id" coletado para listar as campanhas da empresa passando a informação no "Body" da requisição

image.png

 

3. inserir_mailing (POST)

Utilize as informações coletadas para preencher o os campos de Json para inserir o mailing.

Segue exemplo completo do Json:

{
    "cliente_id": 37,
    "campanha_id": 800,
    "ignorar_linha_cabecalho": 0,
    "tipo_envio_mailing": 1,
    "mailing": [
        [
            "Daniel",
            "9999999999",
            "000000",
            "11958371540"
        ],
        [
            "Vanderson",
            "8888888888",
            "000000",
            "13999999999"
        ]
    ],
    "nome": "Mailing de teste Postman",
    "campos": [
        "NOME",
        "CPF/CNPJ",
        "CONTRATO",
        "TELEFONE"
    ],
    "tipos": [
        1
    ],
    "alteraveis": [
        0
    ],
    "posicao": [
        0
    ],
    "numero_tentativas": 0,
    "formato_numero": 0
}

Obs: 

  • No campo "mailing" cada array representa uma linha de contato do mailing. 

     

        "mailing": [
        [
            "Daniel",
            "9999999999",
            "000000",
            "11958371540"
        ],
        [
            "Vanderson",
            "8888888888",
            "000000",
            "13999999999"
        ]
    ],

     

  • A quantidade de campos no array do "mailing" deve ser a mesma passada no campo "campos", onde será informado o nome das colunas
    "campos": [
        "NOME",
        "CPF/CNPJ",
        "CONTRATO",
        "TELEFONE"
    ],


 

 

Back to top