Introdução

Esta documentação descreve o padrão de APIs do Gov.pi Conecta, abrangendo tanto as APIs internas quanto as de parceiros.
O objetivo é estabelecer boas práticas de desenvolvimento amplamente utilizadas como referência na Web, baseadas na OpenAPI Specification v3.1.0 (OAS 3.1) e no modelo de APIs REST.

Sobre o OpenAPI Specification (OAS):
Define uma interface padrão, independente de linguagem, para APIs HTTP.
Isso permite que humanos e sistemas descubram e entendam os recursos do serviço sem acesso ao código-fonte ou à inspeção de tráfego.
Uma definição OpenAPI pode ser usada para:

gerar documentação automaticamente;

criar clientes e servidores em várias linguagens;

facilitar testes e monitoramento.
Referência: OpenAPI v3.1.0

Sobre o REST:
Representational State Transfer (REST) é uma arquitetura de software que define princípios para o funcionamento de APIs.
Ela foi criada como diretriz para comunicação confiável e de alta performance em escala, garantindo portabilidade entre plataformas.
APIs que seguem esse estilo são chamadas RESTful.
Referência: O que é API RESTful? – AWS

O objetivo principal desta documentação é orientar os órgãos e sistemas que integram com o Gov.pi Conecta, garantindo:

consumo mais simples das APIs;
padronização na comunicação;
maior agilidade na entrega de serviços digitais.

Detalhes

Todas as APIs devem seguir o padrão REST, aplicando seus conceitos da forma mais fiel possível.
Além disso, esta documentação apresenta especificações adicionais para garantir:

consistência de arquitetura;
experiência confortável para quem consome as APIs;
clareza e manutenção simplificada para os desenvolvedores que as fornecem.

Uma API de exemplo é disponibilizada ao longo do documento para ilustrar os conceitos abordados e detalhar como aplicar cada requisito.