Pular para o conteúdo principal
Version: 1.0.0

Prosas API REST

Para começar a usar os produtos e serviços da Plataforma Prosas por meio da REST API é necessário ter um cadastro de Administrador na Prosas. Se não possuí entre em contato com nosso time.

O uso da REST API da Plataforma Prosas requer autenticação para que a plataforma saiba quem está fazendo solicitações e quais permissões você tem. Crie um token de API para conceder acesso à API para executar ações.

Compartilhamento de Recursos de Origem Cruzada (CORS)

Esta API oferece Compartilhamento de Recursos de Origem Cruzada (CORS) implementado em conformidade com a especificação do W3C (https://www.w3.org/TR/cors/).

Isso permite a comunicação entre domínios diferentes a partir do navegador.

Todas as respostas possuem um caractere curinga de mesma origem, o que as torna completamente públicas e acessíveis a todos, incluindo qualquer código em qualquer site.

Autenticação

É possível autenticar usando o protocolo OAuth2.

OAuth2 - um protocolo aberto para permitir autorização segura de forma simples e padronizada em aplicações web, móveis e de desktop.

Fluxo de autenticação

O fluxo adotado é o Client Credentials Flow, ideal para autenticação servidor-servidor, sem interação humana direta.

Para mais detalhes ver (RFC 6749)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.4]

O secret usado para gerar o token de autenticação deve ser mantido em ambiente seguro

Authentication

Fluxo de autenticação OAuth2 Client Credentials

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Scopes:

  • public: Acesso público básico

  • confidential:processos.read: Listar processos

  • confidential:inscricoes.read: Listat incrições de um processo