# Endpoints de Integração SSP/INRC
#### Precisamos disponibilizar dois endpoints, para o acesso externo pelo INRC – (Índice Nacional de Registro Civil), com a finalidade de realizarem consulta biográfica e biométrica na base do Goiás Biométrico. ####
### **Swagger - URLs**:
Homologação - https://api-hgoiasbiometrico.ssp.go.gov.br/swagger/ui/index#/RG
Produção - https://apigoiasbiometrico.ssp.go.gov.br/swagger/ui/index#/RG

Todos os endpoints devem conter token fixo no header

token Homologação - 021abe7c292bbbc5348cf7dd91168be8
token Produção - ********************************

#### Endpoints a serem disponibilizados para consumo pelo INRC: ####

ConsultaINRCBiografia
ConsultaINRCImagem

### **Detalhes dos endpoints**:

==**1 - ConsultaINRCBiografia**==

**url:** https://api-hgoiasbiometrico.ssp.go.gov.br/RG/ConsultaINRCBiografia
**method:** GET
**accept:** application/json
**Parâmetros:** todos requeridos.

**cpfUsuario** string*;
**nomeUsuario** string*;
**numRG** string*;
**rgUF** string*;
**sistemaOrigem** string*;
**Authorization** string*; (header) token

**Retornos:**

**200** – JSON - OK - Json com dados do registro solicitado.

**400** – JSON – Dados inválidos – schema:

[
  {
    "msg": "Campo obrigatório",
    "campo": "numRg"
  }
]   

**401** – JSON –Acesso não autorizado/necessário autenticação

[
  {
    "msg": "Acesso não autorizado"
  }
]

**403** – JSON – Acesso não permitido a operação

[
  {
    "msg": "Acesso não permitido para esta operação"
  }
]

**404** – (sem resposta) – Cidadão não encontrado

**500** – JSON – Erro interno da aplicação

[
  {
    "msg": "Ocorreu um erro interno no servidor"
  }
]

==**2 - ConsultaINRCImagem**==

**url:** https://api-hgoiasbiometrico.ssp.go.gov.br/RG/ConsultaINRCImagem
**method:** GET
**accept:** application/json
**Parâmetros:** todos requeridos.

**cpfUsuario** string*;
**nomeUsuario** string*;
**descricaoImagem** string*;
**numRG** string*;
**rgUF** string*;
**sistemaOrigem** string*;
**Authorization** string*; (header) token

**Retornos:**

**200** – JSON – OK - Json com resultado das imagens do registro solicitado.

**400** – JSON – Dados inválidos – schema:

[
  {
    "msg": "Campo obrigatório",
    "campo": "numRG"
  }
]

**401** – JSON – Acesso não autorizado/necessário autenticação

[
  {
    "msg": "Acesso não autorizado"
  }
]

**403** – JSON – Acesso não permitido a operação

[
  {
    "msg": "Acesso não permitido para esta operação"
  }
]

**404** – (sem resposta) – Imagem não encontrada

**500** – JSON – Erro interno da aplicação

[
  {
    "msg": "Ocorreu um erro interno no servidor"
  }
]

### **Detalhes:**

Os parâmetros **rgUF**, possuem a lista de UFs permitidas, segue:
AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO

O parâmetro **descricaoImagem**, possui a lista de imagens permitidas, segue:
TODAS, MAO_DIREITA_POLEGAR, MAO_DIREITA_INDICADOR, MAO_DIREITA_MEDIO, MAO_DIREITA_ANULAR, MAO_DIREITA_MINIMO, MAO_ESQUERDA_POLEGAR, MAO_ESQUERDA_INDICADOR, MAO_ESQUERDA_MEDIO, MAO_ESQUERDA_ANULAR, MAO_ESQUERDA_MINIMO, ROSTO

### **Massa de teste:** ###
ConsultaINRCBiografia?cpfUsuario=32052448004&nomeUsuario=Teste&numRG=7000283&rgUF=GO&sistemaOrigem=INRC-AL&authorization=021abe7c292bbbc5348cf7dd91168be8

ConsultaINRCImagem?cpfUsuario=32052448004&nomeUsuario=Teste&numRG=7000283&rgUF=GO&sistemaOrigem=INRC-AL&descricaoImagem=MAO_DIREITA_ANULAR&authorization=021abe7c292bbbc5348cf7dd91168be8

**/Rg/ConsultaINRCBiografia**
cpfUsuario = 21520279060
nomeUsuario = TESTE
numRG = 7000283 (pode utilizar outra numeração na sequencia para verificar os resultados)
rgUF = GO
sistemaOrigem = INRC-AL
authorization = 021abe7c292bbbc5348cf7dd91168be8

**/Rg/ConsultaINRCImagem**
cpfUsuario = 21520279060
nomeUsuario = TESTE
numRG = 7000283 (pode utilizar outra numeração na sequencia para verificar os resultados)
rgUF = GO
sistemaOrigem = INRC-AL
descricaoImagem = MAO_DIREITA_ANULAR
authorization = 021abe7c292bbbc5348cf7dd91168be8