Acesso Automatizado (REST API Swagger)

Acesso automatizado para sistemas externos, utilizando formatos abertos, estruturados e legíveis por máquina.

Introdução

A Prefeitura Municipal de Itaporã do Tocantins-TO tem o compromisso de tornar os dados de seu Portal Oficial acessíveis a todos, desde entusiastas individuais a qualquer máquina que tenha necessidade processar dados abertos para suas finalidades com responsabilidade.

Como começar?

Clique aqui e veja como você pode começar a usar as APIs do Portal da Prefeitura Municipal de Itaporã do Tocantins-TO usando nossa coleção pública com o Postman.

BASE URL https://www.itapora.to.gov.br/api/site/

Para uso da API é necessário ter um e-mail e senha válidos como parâmetros. Para criar suas credenciais, Cadastre-se aqui.
api/site/diarios/Relatórios do Diário Oficial Relatórios do Diário Oficial Api
GET api/site/diarios

Parameters / Data Types:

  • id int(11)
  • number varchar(50)
  • code varchar(50)
  • cover varchar(400)
  • downloads int(11)
  • file varchar(400)
  • file_size varchar(30)
  • date_at timestamp
  • extra varchar(2)
  • suplementary_id int(11)
  • suplementary_number int(11)
  • hash varchar(100)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: diario_id, Value: integer ID do Diário

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
diarios Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 4, "page": 1, "pages": 1, "diarios": [ { ... } ]}
                
                    {
                        "id": "8974",
                        "number": "4",
                        "code": " dark:bg00420248974",
                        "cover": null,
                        "downloads": "2",
                        "file": "URL/diario004.pdf",
                        "file_size": "274152",
                        "date_at": "2024-09-30 14:39:04",
                        "extra": "N",
                        "suplementary_id": null,
                        "suplementary_number": null,
                        "hash": "c4862c72b4003f067a518ff3264ceeda"
                    }
                
api/site/noticias/Relatórios do Blog Relatórios do Blog Api
GET api/site/noticias

Parameters / Data Types:

  • id int(11)
  • unidade_id int(11)
  • title varchar(255)
  • uri varchar(255)
  • tag varchar(80)
  • subtitle text
  • content text
  • cover varchar(255)
  • views int(11)
  • video varchar(200)
  • video_youtube_id varchar(70)
  • date_at timestamp

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: post_id, Value: integer ID do Post

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
posts Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 580, "page": 1, "pages": 12, "posts": [ { ... } ]}
                
                    {
                        "id": "531",
                        "unidade_id": "1",
                        "title": "COMUN dark:bgICADO DA REDE MUNICIPAL DE EDUCAÇÃO",
                        "uri": "comunicado-da-rede-municipal-de-educacao",
                        "tag": "",
                        "subtitle": "COMUNICADO",
                        "content": "COMUNICADO DA REDE MUNICIPAL TEXTO EXEMPLO 2024.",
                        "cover": "URL/post-id-comunicado-da-rede.jpg",
                        "video": "https://www.youtube.com/watch?v=FKaK9b1O1cU",
                        "video_youtube_id": "FKaK9b1O1cU",
                        "views": "258",
                        "date_at": "2022-01-24 15:29:00"
                    }
                
api/site/noticias/anexos Relatórios dos Anexos do Blog Relatórios dos Anexos do Blog Api
GET api/site/noticias/anexos

Parameters / Data Types:

  • id int(11)
  • post_id int(11)
  • anexo varchar(255)
  • uri varchar(255)
  • type varchar(15)
  • size varchar(30)
  • hash varchar(100)
  • downloads int(11)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: post_id, Value: integer ID do Post

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
anexos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 5, "page": 1, "pages": 1, "anexos": [ { ... } ]}
          dark:bg       
                    {
                        "id": "1",
                        "post_id": "1",
                        "anexo": "URL/gb-postid-1-7b12b.jpg",
                        "type": "image",
                        "size": null,
                        "hash": null,
                        "downloads": null
                    }
                
api/site/licitacoes/ Relatórios dos Procedimentos Licitatórios Relatórios dos Procedimentos Licitatórios Api
GET api/site/licitacoes

Parameters / Data Types:

  • id int(11)
  • number varchar(10)
  • year varchar(255)
  • number_process varchar(50)
  • content text
  • modalidade_id int(11)
  • unidade_id int(11)
  • situacao_id int(11)
  • value decimal(10,2)
  • publicacao_date_at timestamp
  • republicacao_date_at timestamp
  • certame_date_at timestamp
  • group_id int
  • video_ytb varchar(200)
  • video_ytb_id varchar(80)
  • video_ytb_embed varchar(200)
  • is_adjudicada varchar(2)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: licitacao_id, Value: integer ID do Processo

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
licitacoes Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "licitacoes": [ { ... } ]}
                
                    {
                        "id": "656",
                        "number": "04",
                        "year": "2023",
                        "number_process": "117/2023",
                        "content": "CONTRATAÇÃO DE EMPRESA ESPECIALIZADA.",
                        "modalidade_id": "88",
                        "unidade_id": "1",
                        "situac dark:bgao_id": "74",
                        "value": "232434.00",
                        "publicacao_date_at": "2023-03-08 03:00:00",
                        "republicacao_date_at": null,
                        "certame_date_at": "2023-03-21 11:00:00",
                        "group_id": "189",
                        "video_ytb": null,
                        "video_ytb_id": null,
                        "video_ytb_embed": null,
                        "is_adjudicada": null
                    }
                
api/site/licitacoes/ Relatórios dos Procedimentos Licitatórios Anexos Relatórios dos Procedimentos Licitatórios Anexos Api
GET api/site/licitacoes/anexos

Parameters / Data Types:

  • id int(11)
  • licitacao_id varchar(10)
  • anexo varchar(400)
  • hash varchar(100)
  • description varchar(200)
  • downloads int(11)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: licitacao_id, Value: integer ID do Processo

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
anexos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, " dark:bgpage": 2, "pages": 15, "anexos": [ { ... } ]}
                
                    {
                        "id": "28553",
                        "licitacao_id": "873",
                        "anexo": "URL/extrato-do-contrato.pdf",
                        "hash": "ce01262f2a82c55047aaa96a07a054b2",
                        "description": 'Extrato do Contrato 002/2024',
                        "downloads": 23
                    }
                
api/site/contratos/ Relatórios dos Contratos Celebrados Relatórios dos Contratos Celebrados Api
GET api/site/contratos

Parameters / Data Types:

  • id int(11)
  • fornecedor_name varchar(150)
  • fiscal_name varchar(150)
  • number varchar(30)
  • year varchar(10)
  • publicacao_date_at DATE
  • vigencia_start_date_at DATE
  • vigencia_end_date_at DATE
  • value decimal(10,2)
  • content text
  • category_id int(11)
  • licitacao_id int(11)
  • unidade_id int(11)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: contrato_id, Value: integer ID do Contrato

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
contratos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "contratos": [ { ... } ]}
                
                    {
                        "id": "123",
                        "fornecedor_name": 'NOME DO FORNECEDOR',
                        "fiscal_name": 'NOME DO FISCAL DO CONTRATO',
                        "nu dark:bgmber": "028",
                        "year": 2024,
                        "publicacao_date_at": "2024-10-13",
                        "vigencia_start_date_at": "2024-05-06",
                        "vigencia_end_date_at": "2024-12-31",
                        "value": "18550.00",
                        "content": "Objeto do contrato",
                        "category_id": "91",
                        "licitacao_id": "871",
                        "unidade_id": "3"
                    }
                
api/site/contratos/anexos Relatórios dos Contratos Celebrados Anexos Relatórios dos Contratos Celebrados Anexos Api
GET api/site/contratos/anexos

Parameters / Data Types:

  • id int(11)
  • contrato_id int(11)
  • description varchar(100)
  • anexo varchar(255)
  • anexo_type_id int(11)
  • downloads int(11)
  • hash varchar(100)
  • size varchar(30)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: contrato_id, Value: integer ID do Contrato

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
anexos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "anexos": [ { ... } ]}
                
         dark:bg            {
                        "id": "4",
                        "contrato_id": "123",
                        "description": 'ContratoNaIntegra.pdf',
                        "anexo": "URL/anexo.pdf",
                        "anexo_type_id": null,
                        "downloads": "122",
                        "hash": "4184f881f2aac68194b3b20e520cc704",
                        "size": "192071"
                    }
                
api/site/orgaos Relatórios dos Órgãos/Deartamentos/Unidades Relatórios dos Órgãos/Deartamentos/Unidades Api
GET api/site/orgaos

Parameters / Data Types:

  • id int(11)
  • title varchar(255)
  • uri varchar(255)
  • logo varchar(255)
  • address int(255)
  • zipcode int(30)
  • sigla varchar(30)
  • phone varchar(20)
  • phone_cel varchar(20)
  • email varchar(80)
  • about text
  • composicao text

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: orgao_id, Value: integer ID do Órgão

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
orgaos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "orgaos": [ { ... } ]}
                
                    {
                        "id": "1",
                        "title": "Prefeitura/Câmara Municipal",
                        "uri": "uri-orgao",
                         dark:bg"logo": null,
                        "address": "Endereço completo - Centro",
                        "zipcode": "00000-000",
                        "sigla": "PMC",
                        "phone": "(99)9999-9999",
                        "phone_cel": "(99)9999-9999",
                        "email": "email@mail.gov.br",
                        "about": "Competências Texto",
                        "composicao": 'Composição Texto'
                    }
                
api/site/documentos Relatórios dos Documentos/Legislação Relatórios dos Documentos/Legislação Api
GET api/site/documentos

Parameters / Data Types:

  • id int(11)
  • unidade_id int(11)
  • type_id int(11)
  • assunto_id int(11)
  • year varchar(10)
  • date_at varchar(30)
  • code varchar(600)
  • title varchar(600)
  • ementa text
  • number varchar(11)
  • src_origin varchar(10)
  • in_destaque varchar(2)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: documento_id, Value: integer ID do Documento

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
documentos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "documentos": [ { ... } ]}
                
                    {
                        "id": "4183",
                        "unidade_id": "1",
                        "ty dark:bgpe_id": "33",
                        "assunto_id": null,
                        "year": "2024",
                        "date_at": "2024-09-30",
                        "code": "MAT-305bbf-30092024143859",
                        "title": "LEI 500/2024 - ALTERA LEI 493",
                        "ementa": "ALTERA LEI 493 - SUBSIDIOS",
                        "number": "",
                        "src_origin": "doc",
                        "in_destaque": "N"
                    }
                
api/site/documentos/anexos Relatórios dos Documentos/Legislação/Anexos Relatórios dos Documentos/Legislação Anexos Api
GET api/site/documentos/anexos

Parameters / Data Types:

  • id int(11)
  • materia_id int(11)
  • anexo varchar(255)
  • type varchar(10)
  • downloads int(11)
  • description text
  • size varchar(30)
  • hash varchar(100)
  • chave varchar(100)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: materia_id, Value: integer ID do Documento

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
anexos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "anexos": [ { ... } ]}
                
         dark:bg            {
                        "id": "5246",
                        "materia_id": "4186",
                        "anexo": "URL/cdcea3a547466adf3ab350dd3f8ef42f.pdf",
                        "type": "pdf",
                        "downloads": 34,
                        "description": 'Anexo 2 - Lei 090/2024',
                        "size": "1.47 MB",
                        "hash": "2a9a9e26eebcdce32398b89fa2abb491",
                        "chave": "ANX-603732-111020241431415246"
                    },
                
api/site/agentes-culturais Relatórios dos Agentes da Cultura Relatórios dos Agentes Culturais Api
GET api/site/agentes-culturais

Parameters / Data Types:

  • id int(11)
  • nivel_qualificacao_id int(11)
  • name varchar(255)
  • nickname varchar(255)
  • photo varchar(255)
  • name_artistic varchar(200)
  • tempo_atuacao varchar(200)
  • organizacao_responsavel varchar(200)
  • areas varchar(300)

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: agente_id, Value: integer ID do Documento

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
agentes Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "agentes": [ { ... } ]}
                
                    {
                        "id": "5",
                        "nivel_qualificacao dark:bg_id": "1131",
                        "name": "Welinaldo Lopes",
                        "nickname": "",
                        "email": "agente@mail.com",
                        "photo": "URL/foto5.jpg",
                        "name_artistic": "naldim das teclas",
                        "tempo_atuacao": "10 anos",
                        "organizacao_responsavel": "Banda SoudCraft",
                        "areas": "1081@1023@60"
                    }
                
api/site/medicamentos-sus Relatórios dos Medicamentos Farmácia Básica Relatórios dos Medicamentos Farmácia Básica Api
GET api/site/medicamentos-sus

Parameters / Data Types:

  • id int(11)
  • description varchar(400)
  • tipo varchar(20)
  • programa varchar(100)
  • quantidade varchar(50)
  • created_at timestamp

Buscar por ID:

Send in header Query Params:

Param: email, Value: email e-mail de login

Param: password, Value: password senha de login

Param: medicamento_id, Value: integer ID do Medicamento

Buscar Paginado:

Send in header Query Params:

Param: page, Value: integer Número da Página

Responses Response content type */* json
CODE 200 OK
CODE 401 Unauthorized
CODE 403 Forbidden
CODE 404 Not Found
results Quantidade de registros
page Página atual
pages Quantidade de páginas
medicamentos Coleção de dados

Exemplo de Retorno da Coleção dos Dados:

                    { "results": 721, "page": 2, "pages": 15, "medicamentos": [ { ... } ]}
                    
                        {
                            "id": "334",
                            "description": "BR0267502U0042 ÁCIDO ACETILSALICÍLICO  100 MG COMPRIMIDO",
                            "tipo": "COMP.",
                            "programa": "ASSISTÊNCIA FARMACÊUTICA",
                            "quantidade": "560",
                            "created_at": "2024-10-03 17:09:13"
                        }
                    
Prefeitura Municipal de Itaporã do Tocantins-TO
© 2024 Todos os direitos reservados.
Versão 02112024b.320neo