Documentação¶
Padrões Técnicos¶
| Parâmetro | Padrão |
|---|---|
| Meio lógico de comunicação | API REST disponibilizada pela Ministério da Fazenda / Secretaria de Apostas e Prêmios |
| Meio físico de comunicação | Internet |
| Protocolo Internet | TLS versão 1.2, com autenticação mútua através de certificados digitais |
| Padrão de troca de mensagens | JSON (JavaScript Object Notation) |
| Padrão de codificação do documento | Formato XML (Extensible Markup Language) conforme recomendação W3C para XML 1.0, disponível em www.w3.org/TR/REC-xml, com codificação de caracteres UTF-8 |
| Padrão de certificado digital | X.509 versão 3, emitido por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira – ICP-Brasil, do tipo A1 ou A3, devendo conter o CNPJ do proprietário do certificado digital |
| Padrão de assinatura digital | XML Digital Signature, Enveloped, com certificado digital X.509 versão 3, com chave privada de tamanho variável, conforme o padrão da ICP-Brasil (1024, 2048, ou mais bits)., com padrões de criptografia assimétrica RSA, algoritmo message digest SHA-256 e utilização das transformações Enveloped e C14N |
| Validação de assinatura digital | Será validada além da integridade e autoria, a cadeia de confiança com a validação das LCR |
| Padrões de preenchimento XML | Campos não obrigatórios do Schema que não possuam conteúdo terão suas tags suprimidas no arquivo XML. Máscara de números decimais e datas estão definidas no Schema XML. Nos campos numéricos inteiro, não incluir a vírgula ou ponto decimal. Nos campos numéricos com casas decimais, utilizar o “ponto decimal” na separação da parte inteira. |
| Compactação | O padrão de compactação adotado para o projeto será o Gzip (GNU zip) com representação base64binary |
| Protocolo de Autenticação | Padrão JWT (JSON Web Tokens) |
Endpoints¶
Endereço de autenticação¶
| Ambiente | URL |
|---|---|
| Homologação | https://auth-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-autenticacao/token |
| Produção | -- |
Para mais detalhes sobre a autenticação, consulte a seção Autenticação na API.
Endpoints de acesso ao serviço¶
URL Base por ambiente:¶
-
Ambiente de Homologação:
https://auth-h-sigap-rec.df-1.estaleiro.serpro.gov.br/ -
Ambiente de Produção:
--
Operações:¶
Informação Importante
Para todas as operações que recebem documentos, o XML que representa o documento deve estar compactado com GZip e com representação base64binary.
Operação para envio de lotes de apostas¶
Recepção de lote diário e detalhado de apostas¶
[POST] /recepcao-aposta/aposta-esportiva/lote
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://api-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-aposta/aposta-esportiva/lote |
| Produção | -- |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| LoteApostaEsportivaXmlGZipB64 | string | Arquivo XML com lote compactado em Gzip base64binary |
Operação para envio de lotes de apostadores¶
Recepção de lote diário e detalhado de apostadores¶
[POST] /recepcao-apostador/apostador/lote
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://api-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-apostador/apostador/lote |
| Produção | -- |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| LoteApostadorXmlGZipB64 | string | Arquivo XML com lote compactado em Gzip base64binary |
Operação para envio de lotes de carteiras¶
Recepção de lote diário e detalhado de carteiras¶
[POST] /recepcao-carteira/carteira/lote
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://api-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-carteira/carteira/lote |
| Produção | -- |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| LoteCarteiraXmlGZipB64 | string | Arquivo XML com lote compactado em Gzip base64binary |
Operações para envio de lotes de operadores¶
Recepção de lote diário e detalhado de operadores¶
[POST] /recepcao-operador/operador/lote/diario
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://api-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-operador/operador/lote/diario |
| Produção | -- |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| LoteOperadorXmlGZipB64 | string | Arquivo XML com lote compactado em Gzip base64binary |
Recepção de lote mensal e detalhado de operadores¶
[POST] /recepcao-operador/operador/lote/mensal
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://api-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-operador/operador/lote/mensal |
| Produção | -- |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| LoteOperadorXmlGZipB64 | string | Arquivo XML com lote compactado em Gzip base64binary |
Operação para envio de lotes de jogos online¶
Recepção de lote diário e detalhado de jogos online¶
[POST] /recepcao-jogo/jogo-online/lote
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://api-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-jogo/jogo-online/lote |
| Produção | -- |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| LoteJogoOnlineXmlGZipB64 | string | Arquivo XML com lote compactado em Gzip base64binary |
Referência da API¶
Documentação de referência da API através do Swagger:
Homologação¶
https://auth-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-autenticacao/swagger-ui/index.html
https://documentacao-h-sigap-rec.df-1.estaleiro.serpro.gov.br/swagger
Produção¶
Em breve.
Documentação Adicional
Todos os endpoints foram documentados com exemplos de retorno, HTTP Codes e ao final do Swagger, na seção "Schemas", há a documentação de códigos diversos, incluindo códigos de mensagens e suas respectivas descrições. Na seção "Schemas" também é possível ver a representação das classes de retorno produzidas nos Json de response da API.
Códigos de Retorno¶
As requisições à API Sigap podem receber como retorno os seguintes código HTTP:
Code / Responses¶
201 OK¶
Tudo funcionou como esperado.
250 Falha na validação do esquema XML do lote¶
A requisição não foi aceita pois existe alguma inconsistência entre o arquivo xml enviado e a validação com o esquema xsd do tipo de arquivo enviado.
400 Requisição inválida¶
A requisição não foi aceita pois existe alguma inconsistência em algum parâmetro. Uma mensagem especificando o tipo de erro será retornado no corpo da resposta.
401 Usuário não autorizado (Unauthorized)¶
Problemas durante a autenticação/autorização.
413 Tamanho máximo do arquivo excedido¶
Tamanho máximo do arquivo permitido 3mb.
500 Erro interno na aplicação¶
Ocorreu algum erro interno no Servidor.