Projete o serviço, não o portal
O portal é apenas um canal. O serviço atravessa web, app, balcão assistido, telefone, quiosque, mensageria, ferramenta interna e sistemas dos órgãos. Comece pelo resultado para o cidadão e pelo processo legal: quem pode solicitar, qual evidência é obrigatória, quem decide, quais prazos existem, como a taxa é paga, o que pode ser exibido e como corrigir ou recorrer.
Identidade e representaçãoAutenticação, nível de confiança, responsáveis, representantes, empresas, agentes públicos, consentimento e delegação.
Solicitação e evidênciaFormulários, rascunhos, elegibilidade, prefill, anexos, assinatura, validação, acessibilidade e atendimento.
Fluxo e decisãoEstado do caso, tarefas, consultas entre órgãos, prazos, análise humana, regras, motivos e recursos.
Pagamento e entregaTaxas, isenção, obrigação, conciliação, devolução, certificado, licença, benefício e comprovante.
Status e comunicaçãoLinha do tempo, pendências, próxima ação, notificações, entrega e preferências do cidadão.
InteroperabilidadeCadastros oficiais, semântica, contratos, finalidade, caching, proveniência e tratamento de erros.
OperaçãoFilas, SLA, carga, exceções, incidente, modo offline, suporte e ownership do serviço.
ConfiançaPrivacidade, segurança, acessibilidade, transparência, auditoria, retenção e prestação de contas.
Dê identidade durável a cada solicitação
O cidadão precisa de um protocolo e uma timeline, mesmo quando cinco órgãos participam. Internamente, preserve identificadores institucionais e correlation IDs, mas não exponha a integração como cinco protocolos desconectados. O caso reúne versão do serviço, solicitante, representação, manifesto de evidências, decisões, pagamento, prazos, comunicações e ponteiros de auditoria.
Pipeline de APIs do serviço ao cidadão01 DescobrirExplique elegibilidade e custoLinguagem simples, canais, prazo, evidências, taxas, acessibilidade e alternativas.
02 IdentificarAutentique proporcionalmenteOIDC, nível de confiança, representação, consentimento, risco e prova assistida.
03 PreencherReutilize fatos autorizadosConsulte registros oficiais com finalidade, fonte, freshness e visibilidade.
04 SolicitarColete dados estruturadosSchema, rascunho, validação, evidência, declaração e assinatura.
05 PagarCrie obrigação idempotentePayment intent, isenção, liquidação, conciliação, recibo, devolução e expiração.
06 ProcessarCoordene trabalho e decisãoRegras, tarefas, prazos, análise, geração de documento e códigos de motivo.
07 InformarPublique status e notifiqueA API de status é a fonte; e-mail, SMS, push e caixa postal apontam para ela.
08 EncerrarEntregue e retenha evidênciaDocumento, benefício, licença, indeferimento, recurso, trilha e métricas.
Autenticação não é autorização
Login Único gov.br e ClaveÚnica demonstram autenticação centralizada. O serviço ainda decide se a pessoa pode agir, qual nível de conta é suficiente e se ela representa menor, empresa, espólio ou terceiro. ID token identifica a sessão; a API recebe access token adequado. RFC 9700, redirect URI exata, PKCE, token curto, escopo mínimo, rotação de chaves e ambientes separados devem ser baseline.
“Uma vez só” depende de governança
Conecta GOV.BR e PIDE materializam a troca segura para que o cidadão não reapresente dados que o Estado já possui. Isso não significa copiar todos os cadastros para um lake. Consulte a fonte oficial para finalidade declarada, retorne campos mínimos, preserve origem e atualização, diferencie fato de inferência, registre base legal e ofereça correção quando o dado estiver errado.
Formulários são contratos versionados
Modele perguntas, validação, seções condicionais, evidências, ajuda, idioma e metadados de acessibilidade em schemas versionados. Salve rascunhos sem exigir confiança máxima cedo demais. Suporte conexão lenta, upload retomável, teclado, leitor de tela, erros claros, ajuda humana e alternativa imprimível/offline. Casos antigos precisam continuar interpretáveis após o redesign.
A máquina de estados é o contrato público
Ciclo de vida legível para o cidadãoRascunhoIniciado e salvo, ainda não enviado.
EnviadoRecebido com data e comprovante.
ValidandoIdentidade, evidência, pagamento e elegibilidade.
Ação necessáriaCorreção, anexo, pagamento ou agendamento.
Em análiseTrabalho do órgão com prazo e responsável.
DecididoDeferido ou indeferido com motivo e recurso.
EntregueDocumento, licença, benefício ou encerramento.
Não exponha estados internos como QUEUE_17_RETRY. Mapeie o workflow para vocabulário estável com atualização, próximo passo, órgão responsável, prazo e ação esperada. Cada transição guarda ator, horário, motivo, estado anterior, novo estado e evidência.
Pagamento é um subsistema financeiro separado
Crie obrigação ou intent ligado ao caso, valor, regra de taxa, pagador, validade e chave de idempotência. Sucesso no redirect não prova liquidação. Processe callbacks assinados, consulte quando necessário, concilie extratos, emita comprovante, trate isenção/devolução e impeça que callbacks duplicados gerem dois documentos.
Notificação é aviso, não fonte da verdade
E-mail, SMS, push, WhatsApp e caixa postal podem falhar ou chegar a outra pessoa. A mensagem contém poucos dados sensíveis e leva ao status autenticado. Registre template, versão, canal, destino tokenizado, envio, resultado do provedor, entrega, idioma, preferência de acessibilidade e evento de origem.
Interoperabilidade exige contrato e dono semântico
OpenAPI descreve endpoints, não resolve significado institucional. Defina identificadores, semântica, órgão responsável, finalidade, lifecycle de schema, erros, limites, suporte, dados de sandbox, depreciação e aviso de mudança. Adapters isolam SOAP, arquivos, filas e legados proprietários do contrato voltado ao cidadão.
| Capacidade | Registro oficial | Contrato da API | Comportamento em falha | Evidência de auditoria |
|---|
| Identidade digital | Provedor de identidade mais autorização do serviço. | OIDC/OAuth, claims, scopes, nível e representação. | Preservar rascunho e oferecer canal assistido. | Evento, confiança, consentimento e metadados. |
| Consulta cadastral | Cadastro do órgão competente. | Finalidade, resposta mínima, atualização e origem. | Retry em fila ou pedir evidência; nunca inventar ausência. | Solicitante, propósito, campos, versão e hash. |
| Solicitação | Serviço de casos e schema do formulário. | Rascunho, envio, ajuste, upload, validação e retirada. | Retry idempotente e upload retomável. | Snapshot, declarações, assinatura e horários. |
| Pagamento | Ledger do tesouro/provedor. | Intent, callback, liquidação, recibo, devolução e conciliação. | Manter pendente até confirmação financeira. | IDs, valor, transições e lote de conciliação. |
| Decisão | Ato autorizado do órgão. | Motivo, documento, vigência, condições e recurso. | Escalar atraso ou conflito. | Ator, autoridade, norma e evidências consideradas. |
| Notificação | Status do caso continua oficial. | Evento, preferência, envio e comprovante de entrega. | Retry por política e troca autorizada de canal. | Template, gatilho, destino e recibos. |
Auditabilidade é arquitetura
Separe histórico de negócio, telemetria de segurança, gestão documental e analytics. Use transições append-only, armazenamento resistente a adulteração quando necessário, relógios sincronizados, identidade do ator, finalidade, proveniência, motivo, versão da política e correlation IDs. Acesso ao caso também é auditável.
Projete para órgãos e conexões degradadas
Sistemas institucionais ficarão indisponíveis. Use filas duráveis, timeout, circuit breaker, idempotência, replay, dead-letter com revisão, cache com staleness explícito e estado visível “aguardando órgão”. Preserve rascunhos localmente e no servidor. Timeout downstream não pode virar indeferimento nem obrigar reinício.
Acessibilidade e atendimento assistido fazem parte da API
WCAG 2.2 é baseline. Teste tecnologia assistiva e usuários reais, considere linguagem e alfabetização regional, evite expiração arbitrária, permita salvar e retomar, explique progresso e autorize atendimento por agente identificado. O balcão deve usar as mesmas APIs e estados, não um processo paralelo invisível.
Inícios
Envios
Válidos
Pagos
Análise
Decisão
Entrega
Sucesso
Meça a jornada do cidadão
Meça descoberta até início, conclusão de rascunho, erros de campo, rejeição de evidência, uso assistido, atraso de conciliação, fila do órgão, conclusão ponta a ponta, prazo violado, entrega de mensagens, recurso, defeito de acessibilidade, contatos repetidos e custo por resultado. Segmente por região, dispositivo, conexão, idioma e canal.
O que eu construiria
Uma plataforma compartilhada com adapters de identidade e representação, catálogo de serviços, formulários por schema, storage de evidências, máquina de estados, orquestração, gateway de interoperabilidade, adapter financeiro, documentos/assinatura, API de status, hub de notificações, stream de auditoria, testes de acessibilidade, console de suporte e modelo analítico. Órgãos possuem política e decisão; plataforma possui contratos e confiabilidade.
O princípio
GovTech de qualidade esconde fragmentação institucional sem esconder responsabilidade. A pessoa deve entender o que o Estado precisa, o que já sabe, quem está agindo, qual o próximo passo, quanto deve demorar, o que foi decidido e como corrigir ou recorrer.