## Prefeitura / SP / São Paulo / Caixa Postal
Retorna mensagens da Caixa Postal do DEC (Domicílio Eletrônico do Cidadão Paulistano) da Prefeitura de São Paulo.


### Site URL
- https://dec.prefeitura.sp.gov.br/public/CaixaPostal/default.aspx

### Request
POST endpoint: `https://api.infosimples.com/api/v2/consultas/pref/sp/sao-paulo/caixa-postal`



| Parameter          | Description                                                                                                                                                                   |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token*             | The token that will authenticate and authorize the request.                                                                                                                   |
| pkcs12_cert*       | Content of the encrypted A1 digital certificate file following <a href="http://api.infosimples.com/consultas/docs/certificados#criptografia">the encryption instructions</a>. |
| pkcs12_pass*       | Password of the encrypted A1 digital certificate following <a href="http://api.infosimples.com/consultas/docs/certificados#criptografia">the encryption instructions</a>.     |
| ignora_nao_lidas** | Se for informado o valor 1, a API não abre as mensagens não lidas da caixa postal. Por padrão o valor é 0 e abre as mensagens não lidas.                                      |
| ignora_lidas**     | Se for informado o valor 1, a API não abre apenas as mensagens lidas da caixa postal. Por padrão o valor é 0 e abre as mensagens lidas.                                       |

> * Required parameter.

> ** Optional parameter. Sometimes it is necessary to set at least one of the optional parameters for the service to work properly.


### Response examples (OK)
```json
{
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": {
    "api_version": "v2",
    "api_version_full": "2.2.9-20230705153819",
    "product": "Consultas",
    "service": "pref/sp/sao-paulo/caixa-postal",
    "parameters": {
      "pkcs12_cert_md5": "aa25eae9298a43740f9a763477c20a1f",
      "pkcs12_pass_md5": "c9c59c5246576b81c3f2712100204dec",
      "ignora_nao_lidas": 0,
      "ignora_lidas": 0
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.2",
    "requested_at": "2023-07-05T16:28:39.000-03:00",
    "elapsed_time_in_milliseconds": 488,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX1/baxKGwcKhROx4o2x5IAd1ahSPnhyoP7sU9RNRCLUtz6zgeYkPzttYnQhnZ7/+EM11sKJmvEjOvA=="
  },
  "data_count": 1,
  "data": [
    {
      "mensagens": [
        {
          "id": "11111111",
          "destinatario": "Exemplo de nome",
          "situacao": "Ciência Tácita",
          "assunto": "SF/SUREM/DEPAC/DIDEF - Notificação de Aceite de NFS-e",
          "natureza": "Exemplo de Natureza",
          "recebimento_datahora": "1111-11-11T11:11:11.111",
          "leitura_datahora": "11/11/1111 11:11:11",
          "ciencia_datahora": "1111-11-11T11:11:11",
          "lida": true,
          "anexo": false,
          "normalizado_recebimento_datahora": "11/11/1111 11:11:11",
          "normalizado_leitura_datahora": "11/11/1111 11:11:11",
          "normalizado_ciencia_datahora": "11/11/1111 11:11:11",
          "conteudo_texto": "Exemplo de mensagem",
          "lida_por": "Exemplo de Texto"
        },
        {
          "id": "11111111",
          "destinatario": "Exemplo de nome",
          "situacao": "Ciência Tácita",
          "assunto": "SF/SUREM/DEPAC/DIDEF - Notificação de Aceite de NFS-e",
          "natureza": "Exemplo de Natureza",
          "recebimento_datahora": "1111-11-11T11:11:11.111",
          "leitura_datahora": "11/11/1111 11:11:11",
          "ciencia_datahora": "1111-11-11T11:11:11",
          "lida": true,
          "anexo": false,
          "normalizado_recebimento_datahora": "11/11/1111 11:11:11",
          "normalizado_leitura_datahora": "11/11/1111 11:11:11",
          "normalizado_ciencia_datahora": "11/11/1111 11:11:11",
          "conteudo_texto": "Exemplo de mensagem",
          "lida_por": "Exemplo de Texto"
        },
        {
          "id": "11111111",
          "destinatario": "Exemplo de nome",
          "situacao": "Ciência Tácita",
          "assunto": "SF/SUREM/DEPAC/DIDEF - Notificação de Aceite de NFS-e",
          "natureza": "Exemplo de Natureza",
          "recebimento_datahora": "1111-11-11T11:11:11.111",
          "leitura_datahora": "11/11/1111 11:11:11",
          "ciencia_datahora": "1111-11-11T11:11:11",
          "lida": true,
          "anexo": false,
          "normalizado_recebimento_datahora": "11/11/1111 11:11:11",
          "normalizado_leitura_datahora": "11/11/1111 11:11:11",
          "normalizado_ciencia_datahora": "11/11/1111 11:11:11",
          "conteudo_texto": "Exemplo de mensagem",
          "lida_por": "Exemplo de Texto"
        }
      ],
      "site_receipt": "https://www.exemplo.com/exemplo-de-url"
    }
  ],
  "site_receipts": [
    "https://www.exemplo.com/exemplo-de-url"
  ]
}
```


### Preview file

The preview file (`site_receipts`) in the response JSON is **generated by the source (website/app)** that processed the automation.

### Code snippets


#### Python
```python
# Tested with: Python 3.10.19, Python 3.14.0
import requests
import base64
# pip install aes-bridge
import aes_bridge

url = 'https://api.infosimples.com/api/v2/consultas/pref/sp/sao-paulo/caixa-postal'
args = {
  "pkcs12_cert":      aes_bridge.encrypt(base64.b64encode(open("certificate.pfx", "rb").read()).decode(), "ENCRYPTION_KEY").decode("ascii").replace("+", "-").replace("/", "_").rstrip("="),
  "pkcs12_pass":      aes_bridge.encrypt("CERTIFICATE_PASSWORD", "ENCRYPTION_KEY").decode("ascii").replace("+", "-").replace("/", "_").rstrip("="),
  "ignora_nao_lidas": "VALUE_OF_PARAMETER_IGNORA_NAO_LIDAS",
  "ignora_lidas":     "VALUE_OF_PARAMETER_IGNORA_LIDAS",
  "token":            "WRITE_YOUR_TOKEN_HERE",
  "timeout":          "300"
}

response = requests.post(url, args)
response_json = response.json()
response.close()

if response_json['code'] == 200:
  print("Retorno com sucesso: ", response_json['data'])
elif response_json['code'] in range(600, 799):
  mensagem = "Resultado sem sucesso. Leia para saber mais: \n"
  mensagem += "Código: {} ({})\n".format(response_json['code'], response_json['code_message'])
  mensagem += "; ".join(response_json['errors'])
  print(mensagem)

print("Cabeçalho da consulta: ", response_json['header'])
print("URLs com arquivos de visualização (HTML/PDF): ", response_json['site_receipts'])
```


## We are here to help
Do you still need to figure something out? Reach us at [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) and our highly qualified support team will be happy to help.
