> For the complete documentation index, see [llms.txt](https://doc.siprov.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.siprov.com.br/referencia-da-api/introducao-tecnica.md).

# Introdução Técnica

A API do Siprov está implementada conforme padrão [REST](https://developer.mozilla.org/pt-BR/docs/Glossary/REST) e todos recursos são consumidos e utilizados por [URLs](https://pt.wikipedia.org/wiki/URL) (endereços) e transportados sobre [HTTPS](https://pt.wikipedia.org/wiki/Hyper_Text_Transfer_Protocol_Secure).&#x20;

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).&#x20;

Toda resposta é gerada em formato JSON com [códigos de retorno padrão HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status) (status code).&#x20;

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.&#x20;

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)](broken://pages/ZmsemT8srdTwDpI5Yrvp) 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.
