REST API

Navegação

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 Palmeirante-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 Palmeirante-TO usando nossa coleção pública com o Postman.

BASE URL https://www.palmeirante.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/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/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/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"
                        }