Documentação OpenDataBio
Nota
Utilize este espaço para publicar orientações específicas da instalação para os seus usuários. Código de conduta, instruções de cadastro e canais de contato são exemplos de conteúdos adequados.
O site oficial do OpenDataBio contém a documentação completa de instalação e uso da plataforma. Indique-o aos usuários que buscam o manual geral do sistema.
Personalizando estas páginas
- Os arquivos Markdown ficam em
resources/docs/{locale}(por exemploresources/docs/pt/Home.md). - Crie novos arquivos
.mdpara adicionar entradas ao menu — o nome do arquivo aparecerá automaticamente como título. - Todo o conteúdo usa o padrão CommonMark. Diretivas Blade como
@ifcontinuam disponíveis quando precisar de trechos dinâmicos. - Depois de salvar, basta publicar ou recarregar a aplicação; não existe etapa extra de build.
Testando a API
Usuários autenticados podem testar as rotas da API com o próprio token. O comando abaixo retorna cinco conjuntos de dados públicos:
curl \
-H "Authorization: Bearer SEU_TOKEN" \
"https://opendb.inpa.gov.br/api/v0/datasets?limit=5"
Mantenha o parâmetro limit baixo durante os testes. A referência completa dos endpoints está disponível na documentação pública da API.