Etapas para Entrar na Rede: Plataforma do Provedor
Neste guia, delineamos as etapas essenciais para uma plataforma de provedor integrar perfeitamente suas capacidades técnicas à rede Belém Aberta, permitindo que lancem suas ofertas. O coorte inicial dentro da Belém Aberta iniciará a fase de descoberta da transação. Este processo compreende três estágios principais: Descoberta, Confiança e Transação (Selecionar, Pedir, Confirmar, Cumprir, Pós-cumprimento). Seguindo as etapas detalhadas neste documento, cada plataforma de provedor pode garantir que suas ofertas se tornem facilmente descobertas em todas as plataformas de buscadores dentro da Belém Aberta. Para estágios subsequentes da transação, os consumidores transitarão sem problemas para a plataforma do respectivo provedor.
Leituras Preliminares
A Rede Belém Aberta é uma implementação do protocolo DSEP, que é baseado no protocolo Beckn.
DSEP, que significa Protocolo Descentralizado de Capacitação e Educação, permitirá a descoberta de conteúdo, cursos, treinamentos, empregos, mentores, bolsas de estudo e mais através do protocolo de descoberta.
DSEP é uma extensão do Protocolo Beckn customizada para Capacitação e Educação.
- Entenda o protocolo Beckn: https://developers.becknprotocol.io/docs/introduction/video-overview/
- Entenda o Protocolo DSEP:
Etapas para integração técnica
Antes de começar, certifique-se de que você preencheu o formulário "Junte-se a Nós" vinculado AQUI para que um membro de nossa equipe possa entrar em contato com você para apoiar sua jornada de integração.
Etapa 1: Definindo Casos de Uso e Histórias de Usuários
Para garantir um lançamento de MVP bem-sucedido na rede Belém Aberta, é crucial começar identificando casos de uso chave e histórias de usuários. Vamos considerar um exemplo prático:
Exemplo de Caso de Uso: Imagine a Organização A, um provedor de conteúdo educacional diversificado simplificando a educação K-12 para estudantes. Eles têm esse conteúdo em sua plataforma, mas precisam de uma exposição mais ampla. Para acessar esse conteúdo, os usuários normalmente devem encontrar a Organização A, visitar sua plataforma e procurar conteúdo específico por nome, série, assunto e mais.
Caso de Uso Chave: O principal objetivo da Organização A é melhorar a descoberta de seus cursos educacionais hospedados em sua plataforma. Eles visam alcançar isso garantindo que seu conteúdo seja acessível em todas as plataformas de buscadores dentro da rede Belém Aberta.
Focando em tais casos de uso chave, pavimentamos o caminho para um lançamento de MVP simplificado na rede Belém Aberta, onde nossos esforços são concentrados em fornecer soluções valiosas para provedores e buscadores.
Etapa 2: Compreender as APIs e as Estruturas
Compreenda 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: Definir Pontos de Dados Essenciais
Definir Pontos de Dados Essenciais para Respostas de Pesquisa.
Para uma resposta simplificada às solicitações de pesquisa, é crucial listar os principais pontos de dados que devem ser compartilhados. Vamos considerar a mesma organização do exemplo anterior. Se uma plataforma buscadora na rede enviar uma solicitação de pesquisa para uma lição de matemática da 9ª série, a resposta da organização deve incluir:
- Nome do Curso: O nome do curso relacionado à lição de matemática da 9ª série.
- Link do Curso: Um link direto para acessar o curso na plataforma da organização.
- Representação Visual: Uma imagem ou miniatura que representa visualmente o curso.
- Nome do Instrutor ou Organização: O nome do instrutor ou da organização que fornece o curso.
Fornecendo estas informações essenciais em resposta às solicitações de pesquisa, garantimos que os buscadores possam descobrir e acessar facilmente o conteúdo relevante, promovendo uma experiência de usuário sem problemas na rede Belém Aberta.
Etapa 4: Mapear os pontos de dados
Mapear os pontos de dados contra os exemplos de chamada de API on_search para ajudar no mapeamento:
on_searchpara cursos.on_searchpara 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 On_search
Integrar a API On_search 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
- Especificação DSEP: https://github.com/beckn/DSEP-Specification/tree/master/artefacts
- Adaptador de Código Aberto Beckn (Servidor de Protocolo): https://github.com/beckn/protocol-server
- Se você estiver enfrentando problemas, por favor compartilhe sua dúvida em https://github.com/orgs/Open-Belem-Network/discussions
- 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 plataformas de buscadores de referência
Testar com plataformas de buscadores de referência (BAPs) 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 um Aplicativo Buscador (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: