Integrar com a API do Koha

[matheusyanmonteiro]

Descrição

US08 Eu, como Sistema , desejo consumir dados da API do KOHA , para armazenar os livros no aplicativo do Livro Livre

Tarefas

Backend

• Configurar autenticação: Implementar autenticação com chave de API ou credenciais seguras fornecidas pela API do KOHA.
• Consumir endpoints da API: Desenvolver funções para consumir os endpoints /biblios ou /items da API do KOHA para obter informações sobre os livros.
• Respeitar cabeçalhos especiais: Garantir que a aplicação envie cabeçalhos como x-koha-embed quando necessário para obter dados relacionados aos livros.
• Tratamento de status da API: Implementar o tratamento adequado para os diferentes códigos de status da API (200, 400, 401, 403, 500, 503).
  • Registrar logs em caso de erros de requisição ou autenticação (códigos 400, 401, 403).
  • Implementar reexecução automática em caso de erros 500 ou 503 (opcional).
• Armazenamento de dados: Criar funções para armazenar os dados dos livros obtidos em uma estrutura local ou banco de dados relacional compatível com o Livro Livre.
• Paginação da API: Implementar a lógica para lidar com grandes volumes de dados, utilizando os parâmetros _page e _per_page para paginar os resultados.
• Filtros de busca: Implementar filtros para permitir a busca por autor, título ou categoria de livro utilizando os parâmetros q e _match fornecidos pela API.

Frontend

• Exibir livros: Criar interface para exibir os livros armazenados no banco de dados ou estrutura local.
• Filtros de busca: Implementar interface para o usuário buscar por autor, título ou categoria, utilizando os filtros da API.
• Paginação na interface: Criar a interface para navegar pelos resultados paginados de livros.

Integração

• Integrar backend e frontend: Testar a integração para garantir que os dados consumidos da API do KOHA sejam armazenados corretamente e exibidos na interface do Livro Livre.
• Testar filtros de busca: Validar a aplicação dos filtros de busca (autor, título, categoria) e verificar se os dados corretos são retornados.
• Testar paginação: Validar que a navegação entre as páginas de resultados funciona corretamente com grandes volumes de dados.
• Monitorar falhas: Monitorar o sistema para garantir que erros de requisição ou falhas de autenticação sejam corretamente tratados e registrados.

Critérios de Aceitação

• A integração com a API do KOHA deve autenticar usando uma chave de API ou credenciais seguras fornecidas.
• O sistema deve ser capaz de consumir endpoints específicos da API do KOHA para acessar informações sobre livros (ex.: /biblios ou /items).
• A aplicação deve respeitar as opções de cabeçalhos especiais, como x-koha-embed, para incluir dados relacionados, como atributos estendidos ou outras informações vinculadas a cada livro.
• O sistema deve tratar adequadamente os códigos de status da API do KOHA:
  • 200 (sucesso) para respostas válidas.
  • 400, 401, ou 403 para erros de requisição ou autenticação, com registro de logs.
  • 500 ou 503 para erros no servidor ou manutenção, com tentativa de reexecução automática (opcional).
• O sistema deve ser capaz de armazenar os dados obtidos em uma estrutura local ou banco de dados relacional no formato compatível com a aplicação do Livro Livre.
• As chamadas à API devem ser configuráveis, permitindo ajustes como paginação (via _page e _per_page) para grandes volumes de dados.
• Deve ser possível filtrar dados por critérios específicos fornecidos pela API, como autor, título ou categoria de livro, usando parâmetros como q e _match.

Detalhes técnicos

Para implementar a integração, explore os métodos e endpoints descritos na documentação oficial da API do KOHA e o guia do desenvolvedor disponível no site do Koha​

Koha Community
Koha API
Koha API

Protótipo

Disponível em: x