Introdução Técnica

Introdução técnica da nossa API.

A API do Siprov está implementada conforme padrão REST e todos recursos são consumidos e utilizados por URLs (endereços) e transportados sobre HTTPS.

Esses recursos implementam verbos HTTP de leitura e escrita, no caso, requisições POST, GET e PUT (não usamos DELETE). A saber, isso é equivalente às ações CRUD (create/criar | read/ler | update/atualizar | delete/remover).

Toda resposta é gerada em formato JSON com códigos de retorno padrão HTTP (status code).

Os endereços são compostos fixamente pelo endereço base https://acesso.siprov.com.br/siprov-api, seguido dos sufixos que denominam o método a ser usado.

A princípio, você deve usar seu usuário e senha para fazer uma autenticação Basic Auth no método Autenticação (/ext/autenticacao) para gerar seu Bearer Token, o qual será usado para autenticar seu acesso em todos os demais endpoints que seguem descritos nos artigos a seguir.