Manual de Integração do DOM/Niterói

Detalhes de Implementação dos Métodos

Modo de Autentificação

Para todos os métodos abaixo, Usuário e Senha devem ser informados via HTTP Basic Auth.

Codificação dos Textos dos Parâmetros

Todo argumento textual deverá ser passado com a codificação UTF-8.

<parâmetro>*

Todo parâmetro seguido de asterisco (*) é obrigatório.

Verifica Usuário e Senha e Retorna Parâmetros Iniciais

URL: ?r=remote/verify

Método: GET

Parâmetro na URL: Nenhum

Obs.: As categorias retornadas têm os códigos estáveis, logo não é necessário verificá-los sempre.

Retorno: Objeto JSON com o seguinte schema:

{
    "type":"object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "required":true,
    "properties":{
        "ok":{
            "type":"boolean",
            "description": "Indica se foi possível realizar a operação",
            "required":true
        },
            "proxima_edicao":{
            "type":"string",
            "description": "Data no formato dd/mm/yyyy da próxima edição",
            "required":true
        },
        "categorias":{
            "type":"array",
            "description": "Listagem das categorias válidas para cadastro",
            "required":true
        },
    }
}
            

Exemplo usando cURL:

 curl -u usuario:senha "https://diariomunicipal.sc.gov.br/?r=remote/verify"
            

Novos Cadastros

A forma de cadastro mais comum, que visa à publicação do ato em uma Edição de uma determinada data deve ser feita pelo "Cadastrar Ato para Publicação". Já na modalidade de item de acervo público, o ato não é publicado em uma determinada Edição do DOM, mas fica armazenado e disponível mediante o mesmo sistema de pesquisa. Esse cadastro de documentos, normalmente antigos, é feito pelo "Cadastrar Item de Acervo Público".

Ainda sobre os tipos de cadastros disponíveis, ressaltam-se 4 pontos importantes em comum:

1. Caso a categoria do Ato seja "1" ou "2", "Metadados para Leis e Decretos (categorias 1 e 2)" podem ser enviados. Aqui enfatizamos que hoje os Metadados são obrigatóros para Itens de Acervo Público, mas que também, futuramente, serão obrigatórios para Cadastros de Novas Publicações;
2. Caso a categoria do Ato seja "6, 7 ou 28", "Metadados para Contratos, Convênios e Empenhos (categorias 6, 7 e 28)" podem ser enviados. Aqui enfatizamos que hoje os Metadados são obrigatóros para Itens de Acervo Público, mas que também, futuramente, serão obrigatórios para Cadastros de Novas Publicações;
3. Basicamente a única diferença dos parâmetros desses cadastros é que para "Cadastrar Ato Para Publicação" deve-se fornecer o parâmetro "Ato[data_publicacao]". Por outro lado, para "Cadastrar Item de Acervo Público", fornece-se o parâmetro "Ato[data_documento]".
4. Todos os cadastros retormam Resposta Padrão para Novos Cadastros.

{
    "type":"object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "required":true,
    "properties":{
        "ok":{
            "type":"boolean",
            "description": "Indica se foi possível realizar a operação",
            "required":true
        },
        "codigo":{
            "type":"integer",
            "description": "Código do Ato Cadastrado",
            "required":true
        },
    }
}
                

curl -u usuario:senha \
    -F "Ato[titulo]=Resolução 123" \
    -F "Ato[cod_categoria]=3" \
    -F "Ato[data_publicacao]=03/12/2020" \
    -F "Ato[anexo]=@arquivo.docx" \
    -F "Ato[url_origem_api]=http://www.dominio.terceiro.com/.../..." \
    "https://diariomunicipal.sc.gov.br/?r=remote/create"
                

curl -u usuario:senha \
    -F "Ato[titulo]=Lei Complementar N.º 1.234, de 01 de Dezembro de 2019" \
    -F "Ato[cod_categoria]=1" \
    -F "Ato[data_publicacao]=03/12/2019" \
    -F "Ato[anexo]=@lei_complementar_1234_2019.docx" \
    -F "Ato[url_origem_api]=www.dominio.terceiro.com/.../..." \
        -F "Metadados[cod_subcategoria]=3" \
        -F "Metadados[status_lei]=2" \
        -F "Metadados[numero]=1234" \
        -F "Metadados[ano]=2019" \
        -F "Metadados[epigrafe]=Lei Complementar N.º 1.234, de 01 de Dezembro de 2019" \
        -F "Metadados[ementa]=Dispõe sobre ...." \
        -F "Metadados[tag_assunto][]=Saúde,Educação" \
        -F "Metadados[projeto_lei]=Projeto de Lei N.º 670/2018" \
        -F "Metadados[data_sancao]=01/12/2019" \
        -F "Metadados[data_inicio_vigencia]=03/12/2019" \
    "https://diariomunicipal.sc.gov.br/?r=remote/create"
                

curl -u usuario:senha \
    -F "Ato[titulo]=Lei Complementar N.º 1.234, de 01 de Dezembro de 1999" \
    -F "Ato[cod_categoria]=1" \
    -F "Ato[data_documento]=01/12/1999" \
    -F "Ato[anexo]=@lei_complementar_1234_1999.docx" \
    -F "Ato[url_origem_api]=www.dominio.terceiro.com/.../..." \
        -F "Metadados[cod_subcategoria]=3" \
        -F "Metadados[status_lei]=2" \
        -F "Metadados[numero]=1234" \
        -F "Metadados[ano]=1999" \
        -F "Metadados[epigrafe]=Lei Complementar N.º 1.234, de 01 de Dezembro de 1999" \
        -F "Metadados[ementa]=Dispõe sobre ...." \
        -F "Metadados[tag_assunto][]=Saúde,Educação" \
        -F "Metadados[projeto_lei]=Projeto de Lei N.º 670/1998" \
        -F "Metadados[data_sancao]=01/12/1999" \
        -F "Metadados[data_inicio_vigencia]=03/12/1999" \
        -F "Metadados[data_revogacao]=11/11/2019" \
    "https://diariomunicipal.sc.gov.br/?r=remote/acervoCreate"
                

Excluir Publicação Programada

URL: ?r=remote/delete

Método: POST

Parâmetro na URL: id = código do documento cadastrado

Retorno: Objeto JSON com o seguinte schema:

{
    "type":"object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "required":true,
    "properties":{
        "ok":{
            "type":"boolean",
            "description": "Indica se foi possível realizar a operação",
            "required":true
        },
        "codigo":{
            "type":"integer",
            "description": "Código do Ato",
            "required":true
        },
    }
}
            

Exemplo usando cURL:

curl -X POST -u usuario:senha "https://diariomunicipal.sc.gov.br/?r=remote/delete&id=<código_ato>"
            

Verificar Status da Publicação

URL: ?r=remote/status

Método: GET

Parâmetro na URL: codigo = código do documento cadastrado

Retorno: Objeto JSON com o seguinte schema:

{
    "type":"object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "required":true,
    "properties":{
        "ok":{
            "type":"boolean",
            "description": "Indica se foi possível realizar a operação",
            "required":true
        },
        "status":{
            "type":"string | null",
            "description": "Novo|Em diagramação|Publicado|Cancelado|Publicado Equivocadamente|Acervo Público|Acervo Removido",
            "required":true
        },
        "data_publicacao":{
            "type":"string | null",
            "description":  "Data no formato dd/mm/yyyy",
            "required":true
        },
        "edicao":{
            "type":"integer | null",
            "description": "N.º da Edição em que foi publicado",
            "required":true
        },
        "pagina":{
            "type":"integer | null",
            "description": "Pág. do ato na Edição",
            "required":true
        },
        "url":{
            "type":"string | null",
            "description": "URL para a publicação oficial (PDF)",
            "required":true
        },
        "url_web":{
            "type":"string | null",
            "description": "URL para a publicação oficial (Página Web)",
            "required":true
        },
    }
}
            

Exemplo usando cURL:

curl -u usuario:senha "https://diariomunicipal.sc.gov.br/?r=remote/status&codigo=<código_ato>"
            

Listar Publicações

URL: ?r=remote/list

Método: GET

Parâmetro na URL: page (número da página atual), count (quantidade de itens por página)

Retorno: Objeto JSON com o seguinte schema:

{
    "type":"object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "required":true,
    "properties":{
        "ok":{
            "type":"boolean",
            "description": "Indicativo de validade semântica da requisição.",
            "required":true
        },
        "result":{
            "type":"array",
            "description": "Lista das publicações",
            "required":false,
            "items":{
                "type":"object",
                "required":false,
                "properties":{
                    "codigo":{
                        "type":"integer",
                        "required":true
                    },
                    "titulo":{
                        "type":"string",
                        "required":true
                    },
                    "categoria":{
                        "type":"string",
                        "required":true
                    },
                    "data_publicacao":{
                        "type":"string",
                        "description": "Formato dd/mm/yyyy",
                        "required":true
                    },
                    "data_cadastro":{
                        "type":"string",
                        "description": "Formato dd/mm/yyyy h:i:s",
                        "required":true
                    },
                    "url_origem_api":{
                        "type":"string",
                        "required":true
                    },
                    "status":{
                        "type":"string",
                        "required":true
                    }
                }
            }
        }
    }
}
            

Exemplo usando cURL:

curl -u usuario:senha "https://diariomunicipal.sc.gov.br/?r=remote/list&page=1&count=50"