Introdução

Esta documentação tem por objetivo fornecer todas as informações necessárias para trabalhar com a nossa API.

Base URL

https://sgobr.saocristovao.se.gov.br

Autenticando requisições

Essa API não é autenticada. Você pode fazer requisições para ela sem precisar de um token de acesso.

Endpoints

Listagem de obras

Retorna todas as obras

Exemplo de requisição

curl -X GET \
    -G "https://sgobr.saocristovao.se.gov.br/api/obras" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "https://sgobr.saocristovao.se.gov.br/api/obras"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Listagem de obras suspensas

Retorna todas as obras atualmente suspensas

Exemplo de requisição

curl -X GET \
    -G "https://sgobr.saocristovao.se.gov.br/api/obras/suspensas" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "https://sgobr.saocristovao.se.gov.br/api/obras/suspensas"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Consultar obra

Retorna uma obra específica de acordo com seu slug

Exemplo de requisição

curl -X GET \
    -G "https://sgobr.saocristovao.se.gov.br/api/obras/molestiae" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "https://sgobr.saocristovao.se.gov.br/api/obras/molestiae"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Relatório Personalizado

Retorna relatório personalizado de todas as obras em andamento

Exemplo de requisição

curl -X GET \
    -G "https://sgobr.saocristovao.se.gov.br/api/obras/seminfra/relatorio" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "https://sgobr.saocristovao.se.gov.br/api/obras/seminfra/relatorio"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());