O Dev Portal

🚧

Centralização da documentação

Aqui conseguimos centralizar as documentações com explicações, tutoriais sobre nossas Soluções, Referência de API e Cases de usos, permitindo a reflexão do uso do produto com aplicação orientada para a compreensão.

Nosso Dev Portal tem um dos seus norteadores ser o guia prático para uso das nossas soluções, com instruções cujo propósito é descrever de forma clara e ordenada nossos produtos.

📘

Como se Orientar

"Soluções" para ter acesso a configurações e operações de nossos produtos via web, tutoriais e guias passo a passo e fluxos de operações com nossas APIs.

"Referência da API"para integrar sistematicamente e/ou saber como funciona o próprio cada APIs, Endpoint e tenha acesso a snippet de códigos para se inspirar e como implementa-los no seu processo de integração.

Status Page, concentra a saúde online das nossas Soluções e APIs, tudo sobre o estado atual pode ser encontrado nessa seção.

Cases de Sucesso Conheça alguns negócios que utilizam nossas soluções e saiba como obtiveram sucesso nos negócios.

👍

Soluções

É onde voce encontra conteúdo em forma de tutoriais e procedimentos, orientado pelas necessidades do usuário.

Nosso Dev Portal tem como princípio ser seu guia no uso das nossas plataforma web, com instruções cujo o propósito é descrever, de forma clara e ordenada, nossos produtos.

👍

Referência da API

É como um mapa. Um mapa informa o que você precisa saber sobre o território, sem ter que sair e verificar o território por si mesmo; a referência de API tem a mesma finalidade para o produto e seu sistema interno.

Como parte importante do uso das soluções, temos nossa Referência da API, com descrições técnicas de como utilizar nossos sistemas via código. É o conhecimento teórico orientado à informação, sendo um material de referência por fornecer verdade e certeza – referências firmes nas quais os usuários podem se apoiar enquanto trabalham. É nossa fonte de verdade e é essencial para proporcionar aos usuários a confiança necessária para realizar seu trabalho.

O material referência da API descreve o funcionamento por trás de cada solução em si. É austero. Não é para ser lido, é definitivamente um material de consulta. Nossa referência de API não deixa dúvidas ou ambiguidades, é totalmente exata e, até certo ponto, é totalmente autoritária.

Embora a referência não tente mostrar como executar tarefas, ela pode e muitas vezes inclui uma descrição de como algo funciona ou a maneira correta de usá-lo.

Alguns materiais de referência (como documentação da API) podem ser gerados automaticamente por muitos softwares, o que é uma maneira poderosa de garantir que o código permaneça fielmente preciso.

👍

Status Page

É uma seção essencial do Dev Portal, onde são fornecidas atualizações em tempo real sobre o funcionamento dos sistemas e Soluções Vindi. Esta seção informa aos usuários sobre qualquer interrupção, falha ou manutenção programada que possa afetar o acesso ou a funcionalidade dos serviços.

Fornece uma descrição clara e concisa do estado atual dos sistemas, indicando se estão operacionais, em manutenção ou apresentando problemas.

Além disso inclui informações sobre a causa do problema, previsão de resolução e quaisquer ações que os desenvolvedores precisem tomar, como alternativas temporárias ou atualizações de código.

Essa seção desempenha um papel fundamental na transparência e na comunicação eficaz entre a nossa equipe de desenvolvimento e os usuários das plataformas, garantindo que todos estejam cientes do status dos sistemas e possam agir adequadamente em resposta a qualquer problema ou interrupção.