Documentação da API de Transparência – Atibaia Vôlei

Visão Geral

A API de Transparência do Atibaia Vôlei fornece acesso aos documentos relacionados à transparência do projeto, como documentos constitutivos, certidões negativas, balanços patrimoniais, DREs e relatórios de Lei de Incentivo. Esta API está disponível para uso público e permite que sistemas automatizados acessem e verifiquem os documentos diretamente.

Base URL

A URL base da API é:

https://atibaiavolei.com.br/wp-json/custom/v1/transparencia-docs

Endpoints Disponíveis

GET /transparencia-docs

Este endpoint retorna todos os documentos de transparência disponíveis no site, organizados por categorias. Cada documento contém as seguintes informações:

Título: O título do documento.
Link: O link direto para o arquivo PDF.

Exemplo de Requisição

GET https://atibaiavolei.com.br/wp-json/custom/v1/transparencia-docs

Exemplo de Resposta

A resposta será um JSON com os documentos disponíveis, categorizados conforme a sua natureza.

Formato da Resposta:

{
  "Documentos de Constituição": [
    {
      "titulo": "Cartão CNPJ",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/cartao-cnpj.pdf"
    },
    {
      "titulo": "Estatuto",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/estatuto.pdf"
    },
    {
      "titulo": "Assembléia Diretoria",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/assembleia-diretoria.pdf"
    },
    {
      "titulo": "Estrutura Organizacional",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/estrutura-organizacional.pdf"
    },
    {
      "titulo": "Alvará",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/alvara.pdf"
    }
  ],
  "Certidões Negativas de Débito": [
    {
      "titulo": "CND RF + INSS",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/certidoes/cnd-rf-inss.pdf"
    },
    {
      "titulo": "CND Prefeitura",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/certidoes/cnd-prefeitura.pdf"
    },
    {
      "titulo": "CND SP",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/certidoes/cnd-sp.pdf"
    },
    {
      "titulo": "CND Trabalhista",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/certidoes/cnd-trabalhista.pdf"
    }
  ],
  "Balanço Patrimonial": [
    {
      "titulo": "Balanço Patrimonial 2021",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/balancos/balanco-2021.pdf"
    },
    {
      "titulo": "Balanço Patrimonial 2022",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/balancos/balanco-2022.pdf"
    },
    {
      "titulo": "Balanço Patrimonial 2023",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/balancos/balanco-2023.pdf"
    }
  ],
  "DRE": [
    {
      "titulo": "DRE 2021",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/dre/dre-2021.pdf"
    },
    {
      "titulo": "DRE 2022",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/dre/dre-2022.pdf"
    },
    {
      "titulo": "DRE 2023",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/dre/dre-2023.pdf"
    }
  ],
  "Lei de Incentivo": [
    {
      "titulo": "Lei Municipal de Incentivo",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/incentivo/lei-municipal-incentivo.pdf"
    },
    {
      "titulo": "Anexo Único 2022",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/incentivo/anexo-unico-2022.pdf"
    },
    {
      "titulo": "Anexo Único 2023",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/incentivo/anexo-unico-2023.pdf"
    },
    {
      "titulo": "Anexo Único 2024",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/incentivo/anexo-unico-2024.pdf"
    }
  ]
}

Parâmetros da Requisição

Este endpoint não requer parâmetros adicionais. Ele retornará todos os documentos de transparência disponíveis no site, categorizados conforme descrito acima.

Códigos de Status

A API retorna os seguintes códigos de status HTTP, dependendo do sucesso ou falha da requisição:

Código	Descrição
200 OK	A requisição foi bem-sucedida, e os documentos foram retornados com sucesso.
404 Not Found	Nenhum documento de transparência foi encontrado.

Exemplo de Uso com cURL

Aqui está um exemplo de como usar o cURL para fazer uma requisição à API e obter os documentos de transparência:

curl -X GET "https://atibaiavolei.com.br/wp-json/custom/v1/transparencia-docs"

Exemplo de resposta:

{
  "Documentos de Constituição": [
    {
      "titulo": "Cartão CNPJ",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/cartao-cnpj.pdf"
    },
    {
      "titulo": "Estatuto",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/documentos/estatuto.pdf"
    }
  ],
  "Certidões Negativas de Débito": [
    {
      "titulo": "CND RF + INSS",
      "link": "https://atibaiavolei.com.br/wp-content/uploads/certidoes/cnd-rf-inss.pdf"
    }
  ]
}

Autenticação

Atualmente, não é necessária autenticação para acessar a API de Transparência. Todos os dados são públicos e podem ser acessados diretamente via requisição HTTP.

Considerações Finais

Esta API foi desenvolvida para fornecer um acesso rápido e estruturado aos documentos de transparência do Atibaia Vôlei. Não há necessidade de autenticação, e a resposta segue um formato JSON padronizado, facilitando a integração com sistemas externos.

Se houver dúvidas ou problemas técnicos, entre em contato com o suporte técnico do site.