SISGRU - Web Services API documentation version v1
https://{environment}/sisgru/services/v1
Introdução
Bem-vindo ao guia de especificação dos Web Services do SISGRU - Sistema de Gestão do Recolhimento da União. Neste guia estão descritos todos os serviços disponibilizados, assim como a forma correta de acessá-los.
Para dúvidas técnicas ou feedback utilize nosso serviço de atendimento SISGRU.
Guia de Recolhimento da União - GRU
Retorna uma lista de GRUs de acordo com os filtros informados.
get /grus
Retorna uma lista de GRUs de acordo com os filtros informados.
Para essa forma de autenticação, as requisições ao web service devem utilizar as credenciais de acesso do Senha SIAFI (usuário e senha).
A autenticação por Usuário/Senha SIAFI está disponível para este serviço.
Para essa forma de autenticação, as requisições ao web service devem utilizar um token JWT gerado e assinado pelo Sistema Externo solicitante. Obs.: o Sistema Externo precisa estar previamente cadastrado no SISGRU.
A autenticação por token JWT está disponível para este serviço.
Headers
- Content-Type: (one of application/xml)
Formato dos dados que o cliente aceita e espera como resposta.
- Accept-Encoding: (one of gzip)
Algoritmo de compactação que o cliente aceita que seja aplicado nos dados a serem retornados.
Query Parameters
- offset: (integer - default: 0 - minimum: 0)
Índice do primeiro registro da página requisitada. Caso este não seja informado, o valor 0 (zero) será considerado, representando o primeiro registro da primeira página.
- page_size: (integer - default: 30000 - minimum: 1 - maximum: 30000)
Quantidade de registros da página requisitada. Caso este não seja informado, o valor máximo definido pelo serviço será utilizado.
- q: required (string)
Lista de filtros a serem aplicados na consulta. Os filtros devem ser informados no formato <parametro>=<valor>, separados pelo caractere "&" e devidademente codificados, seguindo o mecanismo conhecido por "Codificação por Cento". Pelo menos um filtro é obrigatório.
Example:
ugEmitente=123456&recolhimento=654321 (sem codificação) ugEmitente%3D123456%26recolhimento%3D654321 (com codificação)
- fields: (string)
Lista de colunas a serem incluídas no resultado. Caso este parâmetro não seja informado, todas as colunas serão incluídas.
Example:
ugEmitente,recolhimento
- fields_exclude: (string)
Lista de colunas a serem excluídas do resultado.
Example:
ugEmitente,recolhimento
HTTP status code 200
A requisição foi executada com sucesso.
Headers
- Content-Encoding: (one of gzip)
Algoritmo de compactação que foi aplicado nos dados retornados, i.e., gzip.
- Link: (string)
Lista de links para navegação entre as páginas do resultado. É recomendado a utilização desses links, ao invés de cria-los manualmente.
Veja exemplo abaixo:
<https://localhost:8080/sisgru/services?offset=0&page_size=100 >; rel="prev",
<https://localhost:8080/sisgru/services?offset=100&page_size=100 >; rel="next" - X-Total-Count: (integer - minimum: 0)
Quantidade total de registros.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<grus>
<gru>
<id>20150100900000000391</id>
<ugArrecadadora>123456</ugArrecadadora>
...
</gru>
...
</grus>
HTTP status code 404
O recurso requisitado não foi encontrado ou não existe.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>404</code>
<message>Página não encontrada.</message>
</error>
</errors>
HTTP status code 422
A requisição possui parâmetros inválidos ou não informados.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>422</code>
<message>Parâmetro obrigatório.</message>
</error>
</errors>
Secured by Senha_Siafi
Headers
- Authorization: (string - pattern: Basic usuario:senha)
As credenciais devem ser concatenadas (usuário:senha), convertidas para Base64 e precedidas pelo prefixo "Basic ".
Example:
Basic QWxhZGRpbjpPcGVuU2VzYW1l
HTTP status code 401
As credenciais não foram informadas ou foram de forma incorreta.
HTTP status code 403
As credenciais são desconhecidas ou não possuem permissão para acessar os dados requisitados.
Secured by Token_JWT
Headers
- Authorization: (string - pattern: Bearer jwt_header.jwt_payload.jwt_signature)
O token JWT, gerado e assinado pelo Sistema Externo, deve ser precedido pelo prefixo "Bearer ". O token funciona como credenciais de acesso do Sistema Externo aos Web Services do SISGRU.
O algoritmo a ser utilizado na geração do token é o "RS256" e, para assiná-lo, deverá ser usada a Chave Privada (descriptografada) que corresponde à Chave Pública do Certificado Digital previamente informado no cadastro do Sistema Externo no SISGRU. O SISGRU utilizará a Chave Pública contida no Certificado para validar a assinatura do token. Obs.: a Chave Privada é de conhecimento/uso exclusivo do Sistema Externo, não devendo ser compartilhada.
Vale destacar que o Certificado Digital informado no cadastro do Sistema Externo no SISGRU deve estar no formato PEM (extensão .pem, .cer ou .crt) sem as cadeias de autoridade, ter tamanho máximo de 6KB, utilizar o algoritmo RSA, estar vigente (não expirado) e ser não autoassinado. Além disso, a Chave Pública contida no Certificado deve ter pelo menos 2048 bits.
No payload do token deve ser informado, obrigatoriamente, o atributo "iss", cujo valor deve corresponder ao que foi informado no cadastro do Sistema Externo no SISGRU (campo "Emissor" da aba "Autenticação").
Opcionalmente, também poderá ser informado no payload o atributo "exp" para delimitar o tempo de expiração do token. O uso desse atributo é mais recomendado no caso de geração de um novo token a cada requisição ao Web Service (nesse caso, um tempo de expiração mais curto favorece a segurança).
Obs.: Em caso de renovação do Certificado Digital, deve ser gerado um novo token JWT assinado com o novo par de chaves (pública e privada) e atualizado o cadastro do Sistema Externo no SISGRU com o novo Certificado público.
Para mais informações sobre como gerar e assinar o token JWT, bem como conhecer a relação de bibliotecas disponíveis por tecnologia utilizada, acesse este endereço.Example:
Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJtZXVzaXN0ZW1hIn0.tsdgPaNwSUaHvAZiYHdVxKJMHRuCbqfjaYYQCIQdDys5ZOikds_GLTCVXf7PBNwk5yivbeC_IT_vEH7_LV-YLflphZPjzwHOKhnuYKK-zq1RD25TTKnq0k7M4SOoIJo2mllVFp8q5ZnbPbkOoYa3tH_6KGsowytlDiMsydwwTqs8YWtO1QsuWgiYGzNAQmFt18YcQRHgGRGPOeVdkmF16BBxL8sw7mDfZ3X4H97r90OdjCDxIt9dlExswau45pJcSZG_rV-MvOBL0N3Cvy-yWHC6JvDU5vExH8QDJitlocJdkmGwiPVRkRrGZuH3czEkJ-9T3lXDbW7IV7EkZBguPA
HTTP status code 401
As credenciais (token JWT) não foram informadas corretamente.
HTTP status code 403
As credenciais (token JWT) são desconhecidas ou houve algum problema ao validá-las, conforme tabela abaixo.
Mensagem |
---|
O algoritmo utilizado pelo Token não é aceito. Utilize o RS256. |
O Emissor do Token (issuer) é obrigatório. |
Nenhum Sistema Externo cadastrado para o Emissor do Token (issuer) informado. |
O Sistema Externo correspondente ao Emissor do Token (issuer) encontra-se excluído. |
Token expirado. |
O Certificado cadastrado para o Sistema Externo está vencido. |
Não foi possível validar a assinatura do Token com a Chave Pública cadastrada para o Sistema Externo. Atualize o Certificado no SISGRU. |
Retorna os dados de uma determinada GRU.
get /grus/{id_gru}
Retorna os dados de uma determinada GRU.
Para essa forma de autenticação, as requisições ao web service devem utilizar as credenciais de acesso do Senha SIAFI (usuário e senha).
A autenticação por Usuário/Senha SIAFI está disponível para este serviço.
Para essa forma de autenticação, as requisições ao web service devem utilizar um token JWT gerado e assinado pelo Sistema Externo solicitante. Obs.: o Sistema Externo precisa estar previamente cadastrado no SISGRU.
A autenticação por token JWT está disponível para este serviço.
URI Parameters
- id_gru: required (string)
Número Identificador da GRU
Example:
20150100900000002000
Headers
- Content-Type: (one of application/xml)
Formato dos dados que o cliente aceita e espera como resposta.
HTTP status code 200
A requisição foi executada com sucesso.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<grus>
<gru>
<id>20150100900000000391</id>
<ugArrecadadora>123456</ugArrecadadora>
...
</gru>
...
</grus>
HTTP status code 404
O recurso requisitado não foi encontrado ou não existe.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>404</code>
<message>Página não encontrada.</message>
</error>
</errors>
HTTP status code 422
A requisição possui parâmetros inválidos ou não informados.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>422</code>
<message>Parâmetro obrigatório.</message>
</error>
</errors>
Secured by Senha_Siafi
Headers
- Authorization: (string - pattern: Basic usuario:senha)
As credenciais devem ser concatenadas (usuário:senha), convertidas para Base64 e precedidas pelo prefixo "Basic ".
Example:
Basic QWxhZGRpbjpPcGVuU2VzYW1l
HTTP status code 401
As credenciais não foram informadas ou foram de forma incorreta.
HTTP status code 403
As credenciais são desconhecidas ou não possuem permissão para acessar os dados requisitados.
Secured by Token_JWT
Headers
- Authorization: (string - pattern: Bearer jwt_header.jwt_payload.jwt_signature)
O token JWT, gerado e assinado pelo Sistema Externo, deve ser precedido pelo prefixo "Bearer ". O token funciona como credenciais de acesso do Sistema Externo aos Web Services do SISGRU.
O algoritmo a ser utilizado na geração do token é o "RS256" e, para assiná-lo, deverá ser usada a Chave Privada (descriptografada) que corresponde à Chave Pública do Certificado Digital previamente informado no cadastro do Sistema Externo no SISGRU. O SISGRU utilizará a Chave Pública contida no Certificado para validar a assinatura do token. Obs.: a Chave Privada é de conhecimento/uso exclusivo do Sistema Externo, não devendo ser compartilhada.
Vale destacar que o Certificado Digital informado no cadastro do Sistema Externo no SISGRU deve estar no formato PEM (extensão .pem, .cer ou .crt) sem as cadeias de autoridade, ter tamanho máximo de 6KB, utilizar o algoritmo RSA, estar vigente (não expirado) e ser não autoassinado. Além disso, a Chave Pública contida no Certificado deve ter pelo menos 2048 bits.
No payload do token deve ser informado, obrigatoriamente, o atributo "iss", cujo valor deve corresponder ao que foi informado no cadastro do Sistema Externo no SISGRU (campo "Emissor" da aba "Autenticação").
Opcionalmente, também poderá ser informado no payload o atributo "exp" para delimitar o tempo de expiração do token. O uso desse atributo é mais recomendado no caso de geração de um novo token a cada requisição ao Web Service (nesse caso, um tempo de expiração mais curto favorece a segurança).
Obs.: Em caso de renovação do Certificado Digital, deve ser gerado um novo token JWT assinado com o novo par de chaves (pública e privada) e atualizado o cadastro do Sistema Externo no SISGRU com o novo Certificado público.
Para mais informações sobre como gerar e assinar o token JWT, bem como conhecer a relação de bibliotecas disponíveis por tecnologia utilizada, acesse este endereço.Example:
Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJtZXVzaXN0ZW1hIn0.tsdgPaNwSUaHvAZiYHdVxKJMHRuCbqfjaYYQCIQdDys5ZOikds_GLTCVXf7PBNwk5yivbeC_IT_vEH7_LV-YLflphZPjzwHOKhnuYKK-zq1RD25TTKnq0k7M4SOoIJo2mllVFp8q5ZnbPbkOoYa3tH_6KGsowytlDiMsydwwTqs8YWtO1QsuWgiYGzNAQmFt18YcQRHgGRGPOeVdkmF16BBxL8sw7mDfZ3X4H97r90OdjCDxIt9dlExswau45pJcSZG_rV-MvOBL0N3Cvy-yWHC6JvDU5vExH8QDJitlocJdkmGwiPVRkRrGZuH3czEkJ-9T3lXDbW7IV7EkZBguPA
HTTP status code 401
As credenciais (token JWT) não foram informadas corretamente.
HTTP status code 403
As credenciais (token JWT) são desconhecidas ou houve algum problema ao validá-las, conforme tabela abaixo.
Mensagem |
---|
O algoritmo utilizado pelo Token não é aceito. Utilize o RS256. |
O Emissor do Token (issuer) é obrigatório. |
Nenhum Sistema Externo cadastrado para o Emissor do Token (issuer) informado. |
O Sistema Externo correspondente ao Emissor do Token (issuer) encontra-se excluído. |
Token expirado. |
O Certificado cadastrado para o Sistema Externo está vencido. |
Não foi possível validar a assinatura do Token com a Chave Pública cadastrada para o Sistema Externo. Atualize o Certificado no SISGRU. |
Pagamentos
Retorna uma lista de pagamentos de acordo com os filtros informados.
get /pagamentos
Retorna uma lista de pagamentos de acordo com os filtros informados.
Para essa forma de autenticação, as requisições ao web service devem utilizar as credenciais de acesso do Senha SIAFI (usuário e senha).
A autenticação por Usuário/Senha SIAFI está disponível para este serviço.
Para essa forma de autenticação, as requisições ao web service devem utilizar um token JWT gerado e assinado pelo Sistema Externo solicitante. Obs.: o Sistema Externo precisa estar previamente cadastrado no SISGRU.
A autenticação por token JWT está disponível para este serviço.
Headers
- Content-Type: (one of application/xml)
Formato dos dados que o cliente aceita e espera como resposta.
- Accept-Encoding: (one of gzip)
Algoritmo de compactação que o cliente aceita que seja aplicado nos dados a serem retornados.
Query Parameters
- offset: (integer - default: 0 - minimum: 0)
Índice do primeiro registro da página requisitada. Caso este não seja informado, o valor 0 (zero) será considerado, representando o primeiro registro da primeira página.
- page_size: (integer - default: 30000 - minimum: 1 - maximum: 30000)
Quantidade de registros da página requisitada. Caso este não seja informado, o valor máximo definido pelo serviço será utilizado.
- q: required (string)
Lista de filtros a serem aplicados na consulta. Os filtros devem ser informados no formato <parametro>=<valor>, separados pelo caractere "&" e devidademente codificados, seguindo o mecanismo conhecido por "Codificação por Cento". Pelo menos um filtro é obrigatório.
Example:
ug=123456&recolhimento=654321 (sem codificação) ug%3D123456%26recolhimento%3D654321 (com codificação)
- fields: (string)
Lista de colunas a serem incluídas no resultado. Caso este parâmetro não seja informado, todas as colunas serão incluídas.
Example:
ug,recolhimento
- fields_exclude: (string)
Lista de colunas a serem excluídas do resultado.
Example:
ug,recolhimento
- sort: (string)
Lista de colunas a serem utilizadas para ordenar o resultado.
Example:
data,valorTotal desc
HTTP status code 200
A requisição foi executada com sucesso.
Headers
- Content-Encoding: (one of gzip)
Algoritmo de compactação que foi aplicado nos dados retornados, i.e., gzip.
- Link: (string)
Lista de links para navegação entre as páginas do resultado. É recomendado a utilização desses links, ao invés de cria-los manualmente.
Veja exemplo abaixo:
<https://localhost:8080/sisgru/services?offset=0&page_size=100 >; rel="prev",
<https://localhost:8080/sisgru/services?offset=100&page_size=100 >; rel="next" - X-Total-Count: (integer - minimum: 0)
Quantidade total de registros.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<pagamentos>
<pagamento>
<id>1234567890</id>
<ug>
<codigo>123456</codigo>
...
</ug>
...
</pagamento>
...
</pagamentos>
HTTP status code 404
O recurso requisitado não foi encontrado ou não existe.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>404</code>
<message>Página não encontrada.</message>
</error>
</errors>
HTTP status code 422
A requisição possui parâmetros inválidos ou não informados.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>422</code>
<message>Parâmetro obrigatório.</message>
</error>
</errors>
Secured by Senha_Siafi
Headers
- Authorization: (string - pattern: Basic usuario:senha)
As credenciais devem ser concatenadas (usuário:senha), convertidas para Base64 e precedidas pelo prefixo "Basic ".
Example:
Basic QWxhZGRpbjpPcGVuU2VzYW1l
HTTP status code 401
As credenciais não foram informadas ou foram de forma incorreta.
HTTP status code 403
As credenciais são desconhecidas ou não possuem permissão para acessar os dados requisitados.
Secured by Token_JWT
Headers
- Authorization: (string - pattern: Bearer jwt_header.jwt_payload.jwt_signature)
O token JWT, gerado e assinado pelo Sistema Externo, deve ser precedido pelo prefixo "Bearer ". O token funciona como credenciais de acesso do Sistema Externo aos Web Services do SISGRU.
O algoritmo a ser utilizado na geração do token é o "RS256" e, para assiná-lo, deverá ser usada a Chave Privada (descriptografada) que corresponde à Chave Pública do Certificado Digital previamente informado no cadastro do Sistema Externo no SISGRU. O SISGRU utilizará a Chave Pública contida no Certificado para validar a assinatura do token. Obs.: a Chave Privada é de conhecimento/uso exclusivo do Sistema Externo, não devendo ser compartilhada.
Vale destacar que o Certificado Digital informado no cadastro do Sistema Externo no SISGRU deve estar no formato PEM (extensão .pem, .cer ou .crt) sem as cadeias de autoridade, ter tamanho máximo de 6KB, utilizar o algoritmo RSA, estar vigente (não expirado) e ser não autoassinado. Além disso, a Chave Pública contida no Certificado deve ter pelo menos 2048 bits.
No payload do token deve ser informado, obrigatoriamente, o atributo "iss", cujo valor deve corresponder ao que foi informado no cadastro do Sistema Externo no SISGRU (campo "Emissor" da aba "Autenticação").
Opcionalmente, também poderá ser informado no payload o atributo "exp" para delimitar o tempo de expiração do token. O uso desse atributo é mais recomendado no caso de geração de um novo token a cada requisição ao Web Service (nesse caso, um tempo de expiração mais curto favorece a segurança).
Obs.: Em caso de renovação do Certificado Digital, deve ser gerado um novo token JWT assinado com o novo par de chaves (pública e privada) e atualizado o cadastro do Sistema Externo no SISGRU com o novo Certificado público.
Para mais informações sobre como gerar e assinar o token JWT, bem como conhecer a relação de bibliotecas disponíveis por tecnologia utilizada, acesse este endereço.Example:
Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJtZXVzaXN0ZW1hIn0.tsdgPaNwSUaHvAZiYHdVxKJMHRuCbqfjaYYQCIQdDys5ZOikds_GLTCVXf7PBNwk5yivbeC_IT_vEH7_LV-YLflphZPjzwHOKhnuYKK-zq1RD25TTKnq0k7M4SOoIJo2mllVFp8q5ZnbPbkOoYa3tH_6KGsowytlDiMsydwwTqs8YWtO1QsuWgiYGzNAQmFt18YcQRHgGRGPOeVdkmF16BBxL8sw7mDfZ3X4H97r90OdjCDxIt9dlExswau45pJcSZG_rV-MvOBL0N3Cvy-yWHC6JvDU5vExH8QDJitlocJdkmGwiPVRkRrGZuH3czEkJ-9T3lXDbW7IV7EkZBguPA
HTTP status code 401
As credenciais (token JWT) não foram informadas corretamente.
HTTP status code 403
As credenciais (token JWT) são desconhecidas ou houve algum problema ao validá-las, conforme tabela abaixo.
Mensagem |
---|
O algoritmo utilizado pelo Token não é aceito. Utilize o RS256. |
O Emissor do Token (issuer) é obrigatório. |
Nenhum Sistema Externo cadastrado para o Emissor do Token (issuer) informado. |
O Sistema Externo correspondente ao Emissor do Token (issuer) encontra-se excluído. |
Token expirado. |
O Certificado cadastrado para o Sistema Externo está vencido. |
Não foi possível validar a assinatura do Token com a Chave Pública cadastrada para o Sistema Externo. Atualize o Certificado no SISGRU. |
Retorna os dados de um determinado pagamento.
get /pagamentos/{id_pagamento}
Retorna os dados de um determinado pagamento.
Para essa forma de autenticação, as requisições ao web service devem utilizar as credenciais de acesso do Senha SIAFI (usuário e senha).
A autenticação por Usuário/Senha SIAFI está disponível para este serviço.
Para essa forma de autenticação, as requisições ao web service devem utilizar um token JWT gerado e assinado pelo Sistema Externo solicitante. Obs.: o Sistema Externo precisa estar previamente cadastrado no SISGRU.
A autenticação por token JWT está disponível para este serviço.
URI Parameters
- id_pagamento: required (string)
Número Identificador do Pagamento
Example:
1234567890
Headers
- Content-Type: (one of application/xml)
Formato dos dados que o cliente aceita e espera como resposta.
HTTP status code 200
A requisição foi executada com sucesso.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<pagamentos>
<pagamento>
<id>1234567890</id>
<ug>
<codigo>123456</codigo>
...
</ug>
...
</pagamento>
...
</pagamentos>
HTTP status code 404
O recurso requisitado não foi encontrado ou não existe.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>404</code>
<message>Página não encontrada.</message>
</error>
</errors>
HTTP status code 422
A requisição possui parâmetros inválidos ou não informados.
Body
Type: application/xml
Example:
<?xml version="1.0" encoding="utf-8"?>
<errors>
<error>
<code>422</code>
<message>Parâmetro obrigatório.</message>
</error>
</errors>
Secured by Senha_Siafi
Headers
- Authorization: (string - pattern: Basic usuario:senha)
As credenciais devem ser concatenadas (usuário:senha), convertidas para Base64 e precedidas pelo prefixo "Basic ".
Example:
Basic QWxhZGRpbjpPcGVuU2VzYW1l
HTTP status code 401
As credenciais não foram informadas ou foram de forma incorreta.
HTTP status code 403
As credenciais são desconhecidas ou não possuem permissão para acessar os dados requisitados.
Secured by Token_JWT
Headers
- Authorization: (string - pattern: Bearer jwt_header.jwt_payload.jwt_signature)
O token JWT, gerado e assinado pelo Sistema Externo, deve ser precedido pelo prefixo "Bearer ". O token funciona como credenciais de acesso do Sistema Externo aos Web Services do SISGRU.
O algoritmo a ser utilizado na geração do token é o "RS256" e, para assiná-lo, deverá ser usada a Chave Privada (descriptografada) que corresponde à Chave Pública do Certificado Digital previamente informado no cadastro do Sistema Externo no SISGRU. O SISGRU utilizará a Chave Pública contida no Certificado para validar a assinatura do token. Obs.: a Chave Privada é de conhecimento/uso exclusivo do Sistema Externo, não devendo ser compartilhada.
Vale destacar que o Certificado Digital informado no cadastro do Sistema Externo no SISGRU deve estar no formato PEM (extensão .pem, .cer ou .crt) sem as cadeias de autoridade, ter tamanho máximo de 6KB, utilizar o algoritmo RSA, estar vigente (não expirado) e ser não autoassinado. Além disso, a Chave Pública contida no Certificado deve ter pelo menos 2048 bits.
No payload do token deve ser informado, obrigatoriamente, o atributo "iss", cujo valor deve corresponder ao que foi informado no cadastro do Sistema Externo no SISGRU (campo "Emissor" da aba "Autenticação").
Opcionalmente, também poderá ser informado no payload o atributo "exp" para delimitar o tempo de expiração do token. O uso desse atributo é mais recomendado no caso de geração de um novo token a cada requisição ao Web Service (nesse caso, um tempo de expiração mais curto favorece a segurança).
Obs.: Em caso de renovação do Certificado Digital, deve ser gerado um novo token JWT assinado com o novo par de chaves (pública e privada) e atualizado o cadastro do Sistema Externo no SISGRU com o novo Certificado público.
Para mais informações sobre como gerar e assinar o token JWT, bem como conhecer a relação de bibliotecas disponíveis por tecnologia utilizada, acesse este endereço.Example:
Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJtZXVzaXN0ZW1hIn0.tsdgPaNwSUaHvAZiYHdVxKJMHRuCbqfjaYYQCIQdDys5ZOikds_GLTCVXf7PBNwk5yivbeC_IT_vEH7_LV-YLflphZPjzwHOKhnuYKK-zq1RD25TTKnq0k7M4SOoIJo2mllVFp8q5ZnbPbkOoYa3tH_6KGsowytlDiMsydwwTqs8YWtO1QsuWgiYGzNAQmFt18YcQRHgGRGPOeVdkmF16BBxL8sw7mDfZ3X4H97r90OdjCDxIt9dlExswau45pJcSZG_rV-MvOBL0N3Cvy-yWHC6JvDU5vExH8QDJitlocJdkmGwiPVRkRrGZuH3czEkJ-9T3lXDbW7IV7EkZBguPA
HTTP status code 401
As credenciais (token JWT) não foram informadas corretamente.
HTTP status code 403
As credenciais (token JWT) são desconhecidas ou houve algum problema ao validá-las, conforme tabela abaixo.
Mensagem |
---|
O algoritmo utilizado pelo Token não é aceito. Utilize o RS256. |
O Emissor do Token (issuer) é obrigatório. |
Nenhum Sistema Externo cadastrado para o Emissor do Token (issuer) informado. |
O Sistema Externo correspondente ao Emissor do Token (issuer) encontra-se excluído. |
Token expirado. |
O Certificado cadastrado para o Sistema Externo está vencido. |
Não foi possível validar a assinatura do Token com a Chave Pública cadastrada para o Sistema Externo. Atualize o Certificado no SISGRU. |