HI — Histórias de Integração (S)
Ponto de vista: ESP — Especificação · Código: HI · Modo Completo: obrigatório · Modo Essencial: obrigatório quando há integrações
O que são
Seção intitulada “O que são”As HI contêm os requisitos de interoperabilidade — troca de dados, APIs, barramentos, integrações internas, externas e com terceiros.
São fundamentais em soluções que se comunicam com sistemas legados, plataformas externas (gov.br, SIGEPE, SEI, etc.) ou APIs de terceiros. Toda integração relevante deve ter uma HI correspondente.
Origem típica
Seção intitulada “Origem típica”- Mapeamento de sistemas integrados (via SIS — DIM para sistemas existentes)
- Contratos de API e documentações de barramentos
- Requisitos de interoperabilidade definidos em HNI e HNE
- Diagnóstico técnico de integrações existentes
Nomenclatura
Seção intitulada “Nomenclatura”ESP-HI-<NNNN>--<descricao-curta>.mdExemplo: ESP-HI-0001--integracao-govbr-autenticacao.md
Metadados obrigatórios
Seção intitulada “Metadados obrigatórios”Toda HI deverá conter:
- identificador único (
ESP-HI-NNNN) - versão e datas de geração e revisão
- sistemas envolvidos (origem e destino)
- tipo de integração (REST, SOAP, mensageria, arquivo, etc.)
- protocolo e formato de dados
- nível de criticidade e disponibilidade exigida
- responsável pela validação técnica
- vínculo com HS e HIOP (INF) correspondentes
Relação com outros tipos de história
Seção intitulada “Relação com outros tipos de história”| Relação | Direção |
|---|---|
| HI deriva de HS e HNE | Integrações necessárias para implementar os requisitos |
| HI alimenta IMP | Contratos de API gerados a partir das HI |
| HI alimenta INF — HIOP | Infraestrutura de integração operacional |
| HI alimenta GDA | Dados trocados nas integrações precisam de classificação |
| HI alimenta PDP | Dados pessoais em integrações requerem avaliação |