A API usa códigos de status HTTP padrão para indicar o sucesso ou falha da chamada da API. O corpo da resposta será JSON no seguinte formato:
{
"message": "Algo deu errado."
}A autenticação é tratada no lado do cliente. O cliente precisa enviar detalhes de autenticação para vários endpoints para que o recurso possa ser obtido de forma correta, os detalhes precisam ser enviado no cabeçalho.
Suponhamos que sua chave de API seja minha-chave-de-api. Você deverá enviar no
seguinte formato :minha-chave-de-api, mantenha o : (dois pontos) na string. O resultado final será algo parecido
com o conteúdo abaixo.
Content-Type: application/json
CustomerId: d311165f-ce91-46da-859f-e3df7abab45d
CustomerKey: UN9rkqEt4tol724K74LefzrLBdnOmYq8mqpMXu7R
| codProduto | string O código do Produto. |
| quantidade | string A quantidade. |
| titulos | Array of strings Títulos adquiridos. |
object Dados do cliente. | |
object Dados de onde foi realizada a compra. |
{- "codProduto": "apcapdobem",
- "quantidade": "1",
- "titulos": [
- "300610000010"
], - "pessoa": {
- "cpf": "010.055.850-08",
- "nomeCompleto": "Nome completo",
- "celular": "(11) 12345-1235",
- "dataNascimento": "01/01/1990",
- "email": "teste@teste.com",
- "endereco": {
- "cep": "01311-929",
- "estado": "SP",
- "cidade": "São Paulo",
- "bairro": "Bela Vista",
- "logradouro": "Avenida Paulista 1745",
- "complemento": "6º Andar"
}
}, - "vendedor": {
- "distribuidor": "João",
- "pdv": "Banca do Zé"
}
}{- "protocolo": 12,
- "quantidade": 3,
- "valor": 10,
- "titulos": [
- "102030",
- "000001",
- "309898"
], - "pessoa": {
- "cpf": "01005585008",
- "nome": "VAGNER AYRES DOS SANTOS",
- "celular": "11123451235"
}
}| protocolo | string protocolo. |
| aprovado | string Status do atendimento. |
{- "protocolo": "4467",
- "aprovado": "true"
}{- "autenticacao": "127aa1ea879fc2f07a06404aa1e9029007",
- "protocolo": 4467,
- "dataConfirmacao": "21/01/2021 16:41:24",
- "texto_sucesso": "null",
- "cupons": {
- "numero": 64295,
- "dezenas": [
- "01",
- "02",
- "05",
- "07",
- "17",
- "18",
- "19",
- "21",
- "23",
- "24",
- "29",
- "30",
- "31",
- "34",
- "42",
- "44",
- "46",
- "49",
- "53",
- "55"
]
}
}Consultando as promoções ativa por produto.
{ }{- "idPromocao": "2061",
- "pulo": "500000",
- "dataVigenciaInicio": "24/01/2021 00:00:00",
- "dataVigenciaFim": "30/01/2021 23:59:59",
- "dataSorteioPrincipal": "31/01/2021 10:00:00",
- "tituloPromocao": "3x5 MIL / 1 HB20+15 MIL / 20xMIL / 1 EXTRA 3 MIL",
- "valorPromocao": "5",
- "titulos": [
- {
- "codigoTipoSorteio": "globosorte",
- "fonteSorteio": "proprio",
- "dataSorteio": "31/01/2021 10:00",
- "urlVideo": null,
- "descricao": "5 MIL REAIS - Valor líquido",
- "ordem": "1"
}, - {
- "codigoTipoSorteio": "globosorte",
- "fonteSorteio": "proprio",
- "dataSorteio": "31/01/2021 10:00",
- "urlVideo": null,
- "descricao": "5 MIL REAIS - Valor líquido",
- "ordem": "2"
}, - {
- "codigoTipoSorteio": "globosorte",
- "fonteSorteio": "proprio",
- "dataSorteio": "31/01/2021 10:00",
- "urlVideo": null,
- "descricao": "5 MIL REAIS - Valor líquido",
- "ordem": "3"
}, - {
- "codigoTipoSorteio": "globosorte",
- "fonteSorteio": "proprio",
- "dataSorteio": "31/01/2021 10:00",
- "urlVideo": null,
- "descricao": "1 HB20 0KM + 15 MIL REAIS - Sugestão de uso do prêmio no valor líquido de R$ 65.000,00",
- "ordem": "4"
}, - {
- "codigoTipoSorteio": "girosorte",
- "fonteSorteio": "proprio",
- "dataSorteio": "31/01/2021 10:00",
- "urlVideo": null,
- "descricao": "20 PRÊMIOS DE R$ 1.000,00 (cada) - Valor líquido",
- "ordem": "5"
}, - {
- "codigoTipoSorteio": "numeroextra",
- "fonteSorteio": "proprio",
- "dataSorteio": "31/01/2021 10:00",
- "urlVideo": null,
- "descricao": "1 GIRO EXTRA DE R$ 3.000,00 - Valor líquido",
- "ordem": "25"
}
]
}Consultar todos os produtos comercializados.
{ }[- {
- "codigo": "apcapsp",
- "titulo": "Cupom APCAP SP",
- "descricao": "Promoção Apcap São Paulo",
}, - {
- "codigo": "apcapdobem",
- "titulo": "Doação para o Hospital de Câncer de Barretos",
- "descricao": "DOAR E CONCORRER",
}, - {
- "codigo": "certificadocaplegal",
- "titulo": "Cap Legal Litoral",
- "descricao": "D.Título de Captalização Cap Legal",
}, - {
- "codigo": "vidacaplimeira",
- "titulo": "T.Vida Cap Limeira",
- "descricao": "D.Vida Cap Limeira",
}, - {
- "codigo": "hipercapmogi",
- "titulo": "Hipercap Mogi",
- "descricao": "Hipercap Mogi",
}
]Consultar titúlo utilizando o protocolo
| protocolo | string protocolo do título gerado. |
{- "protocolo": 4467
}{- "protocolo": 4467,
- "situacao": "confirmada",
- "valor": 10,
- "quantidade": 1,
- "dataTransacao": "2020-08-18T13:36:05.000Z",
- "dataConfirmacao": "2020-08-18T13:36:15.000Z",
- "vendedor": {
- "pdv": "Banca do zé",
- "vendedor": "João"
}
}Consultar titúlo utilizando o lote
| dataInicio | date Data início |
| dataFim | date Data fim |
{- "dataInicio": "28/12/2020",
- "dataFim": "31/12/2020"
}[- {
- "protocolo": 12345,
- "situacao": "pendente",
- "valor": 10,
- "quantidade": 1,
- "dataTransacao": "2020-12-28 13:36:05",
- "dataConfirmacao": null,
- "vendedor": {
- "pdv": "Banca do zé",
- "distribuidor": "João"
}
}, - {
- "protocolo": 1234567,
- "situacao": "confirmada",
- "valor": 10,
- "quantidade": 1,
- "dataTransacao": "2020-12-29 14:36:45",
- "dataConfirmacao": "2020-08-29 14:37:00",
- "vendedor": {
- "pdv": "Banca do zé",
- "distribuidor": "João"
}
}, - {
- "protocolo": 12345678,
- "situacao": "cancelada",
- "valor": 10,
- "quantidade": 1,
- "dataTransacao": "2020-08-30 13:36:05",
- "dataConfirmacao": null,
- "vendedor": {
- "pdv": "Banca do zé",
- "distribuidor": "João"
}
}
]