Documentação

O serviço API VIO está exposto através de HTTP REST oferecendo operações que permitem as aplicações realizarem a conexão ao serviço.

Para usar o serviço é necessário ter acesso as chaves após contratação.

Guia Rápido API ENCODER

Guia Rápido API DECODER

Manuais

Manual de Solicitação de Credenciamento

Códigos de Retorno

Código de retorno	Resumido	Explicação
200	OK	Tudo Funcionou como esperado
400	Requisição inválida. A requisição não foi aceita.	Geralmente por falta de um parâmetro requerido.
401	Não autorizado	Problemas durante a autenticação das chaves ou acesso ao template.
402	Requisição falhou	Os parâmetros foram validados, mas houve algum erro de conexão ou acesos ao serviço.
404	Não encontrado	O recurso solicitado não existe.
500	Erro no servidor	Ocorreu algum erro interno.

Endpoints

Api Vio Encoder

Produção: https://gateway.apiserpro.serpro.gov.br/vioenc/v1/encode

Homologação: https://gateway.apiserpro.serpro.gov.br/vio-encoder-default/v1/encode

Api Vio Decoder

Produção: https://gateway.apiserpro.serpro.gov.br/viodec

Homologação: https://gateway.apiserpro.serpro.gov.br/viodec-trial/v1/decode

Lista de caracteres permitidos para codificação

ABCÇDEFGHIJKLMNOPQRSTUVWXYZabcçdefghijklmnopqrstuvwxyz 0123456789áàéíóúüñÁÀÉÍÓÚÜÑÃãÂâÔôÕõ =+-/*_|()[]{}<>#%&@'.:;,!?$"~^êÊ\nºª