iSix Play Api

Introdução

Documentação para integração aos serviços da plataforma iSix Play Api.

Características do serviço

O serviço utiliza a arquitetura REST (Representational State Transfer), que utiliza os verbos HTTP (GET, POST, PUT e DELETE) para executar as operações. A API suporta o formato JSON, definido através do cabeçalho HTTP "content-type":

content-type:application/json

O protocolo padrão para comunicação com as APIs REST é HTTP 1.1 e a codificação de caracteres é UTF-8.

Requisições

Todas as requisições devem conter o cabeçalho de autorização HTTP com os dados de acesso (login e senha) referentes a um usuário ativo no iSix Play.

Os dados de acesso, devem estar codificados em base 64 com o formato LOGIN:SENHA

Exemplo: se o login é "0123ABCDEF" e a senha é "A1B2C3D4E5", o cabeçalho de autorização deve ser o seguinte:

Authorization: Basic

Authorization: Basic MDEyM0FCQ0RFRjpBMUIyQzNENEU1

Exemplo de cabeçalho de requisição:

POST https://api.isixdigital.com.br/api/Grupo HTTP/1.1
Accept-Encoding: gzip,deflate
Accept-language: pt-br
Content-Type: application/json
Content-Length: 771
Host: api.isixdigital.com.br
Connection: Keep-Alive
Authorization: Basic MDEyM0FCQ0RFRjpBMUIyQzNENEU1

O corpo da requisição é definido conforme o tipo de serviço solicitado.

A resposta do serviço contém um código (0 para mensagem de sucesso, 88 para mensagem de negócio e 99 para mensagem de erro), criticas e dados.

O JSON abaixo exemplifica uma resposta do serviço.

{
  "cod": 0,
  "criticas": [
    {
      "critica": "sample String 1"
    },
    {
      "critica": "sample String 1"
    }
  ],
  "dados": {
    "acordos": {...}
  }
}

Instruções sobre preenchimento de objetos:

Formato JSON
- Atributos não declarados no corpo da requisição serão desprezados.
- Atributos preenchidos com null ou "", serão desprezados.
- Atributos numéricos, com valores maiores que 1, não devem iniciar com 0 (zero).
  Exemplos de valores não permitidos: "0123", "010.25", "03.45".
- Atributos do tipo inteiro, decimal ou boleano devem ser preenchidos sem aspas "".
- Atributos do tipo boleano, podem ser preenchidos com os seguintes valores: true, false, 1, 0.
Verbo PUT (Atualização de dados)
- Atributos preenchidos com "-1" (para tipos numéricos, enumeradores e string) e "01-01-0001" (para tipo datetime), serão interpretados como uma solicitação de nulidade

A estrutura completa que compõe o corpo das requisições de envio e retorno é descrita no tópico “Métodos“.

Endpoints

Ambiente de Produção

URL: https://api.isixdigital.com.br

Exemplos de código

using System;
    using System.Net.Http;
    using System.Net.Http.Headers;
    using System.Threading.Tasks;

namespace API_ISIXPlay_Exemplo_CSharp
    {
        internal class Program
        {
            static async Task Main(string[] args)
            {
                var url = "https://api.isixdigital.com.br";
                var usr = "usuario";
                var pwd = "senha";
                var result = "";

var client = new HttpClient();
                client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Base64Encode(usr + ":" + pwd));
                client.DefaultRequestHeaders.Add("Accept", "application/json");

//Consultar grupo
                var request = new HttpRequestMessage(HttpMethod.Get, url + "/api/Grupo");
                var response = await client.SendAsync(request);
                response.EnsureSuccessStatusCode();
                result = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Resultado consulta grupo: " + result );

//Gerar Token
                request = new HttpRequestMessage(HttpMethod.Post, url + "/api/Token");
                var content = new StringContent("{\"dados\": {\"codGrupoCRM\": \"teste\",\"dataLote\": \"2022-12-26\",\"sequencialLote\": \"01\",\"classificacaoLote\": \"C\"}\r\n}", null, "application/json");
                request.Content = content;
                response = await client.SendAsync(request);
                response.EnsureSuccessStatusCode();
                result = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Resultado gerar Token: " + result);
            }
            static private string Base64Encode(string plainText)
            {
                var plainTextBytes = System.Text.Encoding.UTF8.GetBytes(plainText);
                return System.Convert.ToBase64String(plainTextBytes);
            }
        }
    }

VB.NET

Imports System.Net.Http
    Imports System.Net.Http.Headers

Namespace API_ISIXPlay_Exemplo_VB

Module Module1

Sub Main()
                Dim t As Task = New Task(AddressOf RequestAsync)
                t.Start()
                Console.ReadLine()
            End Sub

Async Sub RequestAsync()
                Dim url = "https://api.isixdigital.com.br"
                Dim usr = "usaurio"
                Dim pwd = "senha"
                Dim result = ""

Dim client = New HttpClient()
                client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Basic", Base64Encode(usr & ":" & pwd))
                client.DefaultRequestHeaders.Add("Accept", "application/json")

'Consultar grupo'
                Dim request = New HttpRequestMessage(HttpMethod.[Get], url & "/api/Grupo")
                Dim response = Await client.SendAsync(request)
                response.EnsureSuccessStatusCode()
                result = Await response.Content.ReadAsStringAsync()
                Console.WriteLine("Resultado consulta grupo: " & result)

'Gerar Token'
                request = New HttpRequestMessage(HttpMethod.Post, url & "/api/Token")
                Dim content = New StringContent("{""dados"": {""codGrupoCRM"": ""teste"",""dataLote"": ""2022-12-26"",""sequencialLote"": ""01"",""classificacaoLote"": ""C""}" & vbCrLf & "}", Nothing, "application/json")
                request.Content = content
                response = Await client.SendAsync(request)
                response.EnsureSuccessStatusCode()
                result = Await response.Content.ReadAsStringAsync()
                Console.WriteLine("Resultado gerar Token: " & result)
            End Sub

Private Function Base64Encode(ByVal plainText As String) As String
                Dim plainTextBytes = System.Text.Encoding.UTF8.GetBytes(plainText)
                Return System.Convert.ToBase64String(plainTextBytes)
            End Function

End Module

End Namespace

Webhooks (HTTP callbacks)

Disparos

Envio para o CRM do cliente os status dos disparos cadastrados no iSix Play (SMS, E-mail, RCS e Whatsapp) via Webhook

Verbo: POST

Parâmetros:
    URI:
        - código CRM do grupo 
        - código do lote de exportação 
        Exemplo: http://empresa.com.br/api/Disparos/123456/S7896

    Body:
        - JSON Array contendo os dados do status do disparo a serem importados pelo CRM do cliente

Retorno da Requisição:
- Status HTTP esperado: 200 OK
- Body: Sem conteúdo

Parâmetro

Descrição

Tipo

Tam.

Obrig.

codGrupoCrm

Código do grupo associado ao subgrupo do contrato.

String

100

descricaoGrupo

Descrição do grupo do subgrupo associado ao contrato do disparo.

String

100

codSubgrupoCrm

Código do subgrupo associado ao contrato do disparo sistema CRM da empresa.

String

100

descricaoSubgrupo

Descrição do subgrupo associado ao contrato do disparo.

String

100

codContratoCrm

Código do contrato associado ao status do disparo no sistema CRM da empresa.

String

100

codCrmCliente

Código do cliente no sistema CRM da empresa.

String

100

nomeCliente

Nome do cliente associado ao contrato do disparo.

String

100

codDisparo

Código de identificação do disparo no iSix Play

Int32

dataHoraDisparo

Data/hora do disparo

Datetime

tipoDisparo

Descrição do tipo de disparo.

String

servico

Descrição do serviço associado ao disparo.

String

100

identificadorServico

Código de identificação do disparo no serviço

Int32

tipoContatoAcionado

Identificação do tipo de contato acionado.

String

codCrmReferencia

Código da referência no sistema CRM da empresa.

String

100

nomeReferencia

Nome da referência do cliente associado ao contato do acionamento disparo.

String

300

contatoAcionado

Contato que foi acionado no disparo (telefone, e-mail, etc.)

String

100

codStatusDisparo

Código do status no sistema iSix Play.

Int32

dataHoraDisparo

Data/hora do disparo.

Datetime

identificadorStatusDisparo

Identificador do status do disparo.
É composto de 3 caracteres, 1 letra e 2 dígitos numéricos

Letra

S = SMS

E = E-mail

R = RCS

W = Whatsapp

Dígitos Numéricos

01 = Disparado para o Serviço

02 = Pendente de Envio para o Destinatário

03 = Enviado para o Destinatário

04 = Entregue ao Destinatário

05 = Envio Cancelado

06 = Erro no Envio ao Destinatário

07 = Lido pelo Destinatário

08 = Clicado pelo Destinatário

09 = Bloqueado

Exemplo: S01 - SMS disparado para o Serviço;

String

descricaoStatusDisparo

Descrição do status do disparo.

String

100

mensagemDisparo

Mensagem enviada no disparo.

String

Exemplo:

                [
                    {
                        "codCrmGrupo":"5857",
                        "descricaoGrupo":"Empresa.com",
                        "codCrmSubgrupo":"2004571",
                        "descricaoSubgrupo":"CART26",
                        "codCrmContrato":"125486985",
                        "codCrmCliente":"26689782",
                        "nomeCliente":"CLIENTE VIP",
                        "codDisparo":8558212,
                        "dataHoraDisparo":"2025-01-01T08:34:54.513",
                        "tipoDisparo":"SMS",
                        "servico":"NEO SMS",
                        "identificadorServico":"52282921",
                        "tipoContatoAcionado":"Telefone Cliente",
                        "codCrmReferencia":null,
                        "nomeReferencia":null,
                        "contatoAcionado":"(01)12345-9876",
                        "codStatusDisparo":172266333,
                        "dataHoraStatusDisparo":"2025-01-01T08:35:55.233",
                        "identificadorStatusDisparo":"S01",
                        "descricaoStatusDisparo":"Sem Retorno"
                        "mensagemDisparo":"CLIENTE VIP, evite protesto em cartorio do seu debito com a Empresa.Com. Ligue 08001234567 ou WhatsApp http://wa.me/1234567890123"
                    }
                ]

Introdução

Características do serviço

Requisições

Endpoints

Ambiente de Produção

Exemplos de código

Webhooks (HTTP callbacks)

Disparos

Métodos

WebHooks