Etapas para Entrar na Rede: Plataforma do Buscador
Este documento delineia as etapas essenciais para uma plataforma de buscadores alcançar a integração técnica e introduzir suas ofertas na rede Belém Aberta. O coorte inicial dentro da rede Belém Aberta concentrará esforços na fase de descoberta das transações. Seguindo as etapas detalhadas neste documento, cada plataforma de buscadores apresentará perfeitamente as ofertas das plataformas de provedores na rede Belém Aberta em sua própria plataforma. Para as etapas subsequentes da transação, os consumidores serão direcionados sem esforço para as respectivas plataformas dos provedores. Esta abordagem garante uma experiência suave e eficiente para os usuários na rede Belém Aberta.
Leituras Preliminares
A rede Belém Aberta é uma implementação do protocolo DSEP, que é baseado no Protocolo Beckn.
- Entenda o protocolo Beckn: https://developers.becknprotocol.io/docs/introduction/video-overview/
- Entenda o Protocolo DSEP:
Etapas para integração técnica:
Etapa 1: Identificar casos de uso e histórias de usuários chave
Identificar casos de uso e histórias de usuários chave para começar, seguindo um MVP para o go-live na rede Belém Aberta.
Exemplo de Caso de Uso para Belém Aberta
Imagine a Organização C, buscando melhorar o apelo da sua plataforma para sua base de usuários existente e atrair novos usuários. O principal objetivo deles é expandir a descoberta de oportunidades de aprendizado e meios de subsistência oferecidas pelas plataformas de provedores dentro da rede Belém Aberta. Em busca desse objetivo, a Organização C pode assumir o papel de uma Plataforma de Buscadores, garantindo assim que todas as ofertas das plataformas de provedores se tornem facilmente descobertas em sua plataforma.
Esse movimento estratégico permite que a Organização C aproveite a riqueza de oportunidades oferecidas dentro da rede Belém Aberta, enriquecendo a experiência do usuário e promovendo o crescimento.
Etapa 2: Compreender APIs e estruturas
Compreender as APIs e as estruturas das especificações e exemplos.
- Exemplos estão disponíveis aqui: https://github.com/beckn/DSEP-Specification/tree/master/artefacts
Etapa 3: Listar os pontos de dados
Listar os pontos de dados que serão enviados como parte da solicitação de busca.
Por exemplo, na Belém Aberta:
Considere o mesmo cenário destacado na etapa 1, onde um usuário chega à plataforma da Organização C em busca de cursos. Para garantir uma experiência amigável ao usuário, os usuários devem ter a capacidade de buscar com base em critérios específicos, como a série ou grupo etário para os quais o curso foi projetado, a duração do curso, os tópicos abordados e mais. Esses pontos de dados essenciais devem ser incluídos na solicitação de busca enviada às plataformas de provedores. Isso garante que as plataformas de provedores possam responder com o conteúdo mais relevante em sua resposta de busca.
Ao fornecer esses critérios de busca específicos, os usuários podem encontrar facilmente os cursos que se alinham aos seus requisitos e preferências, melhorando a eficácia geral e a satisfação do usuário na plataforma Belém Aberta.
Etapa 4: Mapear os pontos de dados
Mapear os pontos de dados contra os exemplos de chamadas de API de busca para ajudar no mapeamento.
- Busca por cursos:
- Busca por bolsas de estudo:
Etapa 5: Registrar-se no sandbox
Registrar-se no sandbox via o formulário de Participante da Rede.
O link para o formulário de Participante da Rede será adicionado aqui em breve.
Etapa 6: Integrar API de busca
Integrar a API de busca via a coleção Postman.
- Exemplos de chamada de API e documentação do protocolo de descoberta: https://dsep.sunbird.org/discovery-protocol-specifications/discovery-protocol
- Adaptador de Código Aberto Beckn (Servidor de Protocolo): https://github.com/beckn/protocol-server
- Beckn Protocol Server é um serviço que ajuda a aplicação a conectar-se à Rede Beckn: Código base do servidor de protocolo: https://github.com/beckn/protocol-server/tree/master
- Documentação sobre o servidor de protocolo: https://github.com/beckn/protocol-server/wiki
Etapa 7: Testar com BPPs de referência
Testar com BPPs (plataformas de provedores) de referência no sandbox.
- As coleções do postman para testes com aplicativos de referência estão aqui: https://raw.githubusercontent.com/beckn/beckn-sandbox/main/artefacts/DSEP-PS-sandbox.postman_collection.json
- Versões hospedadas da plataforma do provedor (BPP) e plataforma do buscador (BAP) podem ser usadas para testar as implementações. Link para a versão hospedada para uma Plataforma de Provedor (BPP): https://sandbox-bpp-network.becknprotocol.io
- Versão hospedada para uma plataforma de buscadores (BAP): https://ps-bap-network.becknprotocol.io
- Link para o Sandbox: https://github.com/beckn/beckn-sandbox/tree/main/artefacts
Etapa 8: Demonstrar o fluxo ponta a ponta
A informação para demonstração será adicionada aqui em breve.
Etapa 9: Implementar assinaturas e validação conforme especificação
- Guia para integração com o Beckn Gateway:
- Código de exemplo para geração de chaves, assinatura e verificação:
- Documentação do Beckn Registry:
- Códigos para serem usados para gerar um par de chaves privadas e públicas: