Professional Documents
Culture Documents
Verso 1.1.9
Sumrio
1
Introduo .............................................................................................................................. 4
Segurana ............................................................................................................................. 4
2.1
2.2
2.3
2.4
2.5
2.6
2.7
Requisitos tcnicos........................................................................................................ 6
2.8
Upload de arquivos................................................................................................................ 7
5.1
5.1.1
5.2
Upload completo.......................................................................................................... 10
5.2.1
5.3
5.5
5.6
6.1.1
Especificao .......................................................................................................... 13
6.2
6.3
6.4
Especificao .......................................................................................................... 11
5.4
6.1
Especificao .......................................................................................................... 10
Consulta a posio do upload ..................................................................................... 11
5.3.1
Especificao ............................................................................................................ 8
Especificao .............................................................................................................. 17
8.1.1
8.2
Especificao .......................................................................................................... 18
Consulta por protocolos .............................................................................................. 20
8.2.1
8.3
9
Verso 1.1.9
Especificao .......................................................................................................... 20
Consulta avanada ...................................................................................................... 21
Senha .................................................................................................................................. 22
9.1
Alterao de senha...................................................................................................... 22
9.1.1
9.2
Especificao .......................................................................................................... 22
Consulta vencimento de senha ................................................................................... 23
9.2.1
Especificao .......................................................................................................... 23
10
11
12
Referncias ......................................................................................................................... 26
13
Suporte ................................................................................................................................ 26
Verso 1.1.9
pelo
STA
seguem
padro
REST
2 Segurana
2.1 Autorizao de uso
O acesso ao STA nos ambientes de homologao e de produo requer que o
operador tenha usurio cadastrado no Sisbacen/Autran e autorizao na transao PSTA300.
A instituio responsvel pelo controle de credenciamento de seus operadores nessa
transao.
Cada operador deve utilizar o seu prprio usurio Sisbacen/Autran. O STA ir
armazenar uma trilha de auditoria para cada operao realizada no sistema.
Cada instituio s ter acesso aos arquivos por ela enviados ou que a ela se
destinam.
ser
Caso no haja nenhum mster habilitado nesse ambiente, a reabilitao de senha deve
solicitada
ao
Deinf/Diate
por
meio
da
aplicao
BC
Correio
Banco
Central
do
Brasil,
2015
4
Verso 1.1.9
usado
na
requisio
est
no
formato
Verso 1.1.9
O hash deve ser calculado sobre o contedo completo do arquivo compactado que ser
transmitido.
O algoritmo de hash utilizado deve ser o SHA-256 [1].
HTTP 1.1
HTTPS
Leitura e manipulao de documentos XML.
Funcionalidade
Upload e Download
Mximo de 10 simultneos
Consulta
Comando
4 Teste de conectividade
Utilizando um navegador Web, possvel realizar um teste simples para verificar se a
conexo com o STA est funcional.
Para teste de conectividade em ambiente de produo, abra um navegador internet e
digite na barra de endereo:
Verso 1.1.9
https://sta.bcb.gov.br/staws/arquivos?tipoConsulta=AVANC&nivelDetalhe=RES
Para teste de conectividade em ambiente de homologao, abra um navegador internet e
digite na barra de endereo:
https://sta-h.bcb.gov.br/staws/arquivos?tipoConsulta=AVANC&nivelDetalhe=RES
O navegador requisitar o usurio e senha. Utilize um usurio vlido, conforme sees:
Caso ocorra algum erro de conexo, possvel que o firewall da sua instituio esteja
bloqueando o acesso. Neste caso, entre em contato com o administrador da sua rede.
5 Upload de arquivos
O servio de upload do STA suporta diversas funcionalidades previstas na
especificao do protocolo HTTP, sendo possvel realizar:
1. Upload completo para enviar o arquivo todo em uma s parte;
2. Retomada de upload (resume) para retomar upload interrompido do ponto
onde parou;
3. Upload em paralelo para permitir reduo significativa no tempo de upload,
ao possibilitar a transmisso de vrias partes do mesmo arquivo ao mesmo
tempo; e
4. Upload de parte de arquivo permite efetuar upload de uma parte especfica
do arquivo, informando-se a posio inicial e final (range).
Importante: Antes de iniciar o upload de um novo arquivo, necessrio requisitar um
protocolo. Caso o upload do arquivo no seja finalizado em 48 horas, o protocolo ser
cancelado.
Ateno: Ao utilizar o upload em paralelo, no se esquea dos limites de conexes abertas
descritas na seo 2.8 Limites de conexes.
Veja tambm Tabela 7: Mensagens de erro de envio de arquivos (upload).
Verso 1.1.9
Especificao
Requisio
POST /staws/arquivos HTTP/1.1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Parametros>
<IdentificadorDocumento>{tipo_arquivo}</IdentificadorDocumento>
<Hash>{hash_sha256}</Hash>
<Tamanho>{tamanho_arquivo}</Tamanho>
<NomeArquivo>{nome_arquivo}</NomeArquivo>
<Observacao>{observao}</ Observacao >
</Parametros>
onde:
Possveis erros:
Status
Descrio
Formato contedo
Banco Central do Brasil, 2015
Verso 1.1.9
application/xml
Verso 1.1.9
Especificao
Requisio
PUT /staws/arquivos/{protocolo}/conteudo HTTP/1.1
{contedo_arquivo}
onde:
Ateno:
1. A requisio no precisa conter o header Content-Type. Caso informado, no
permitido multipart/form-data;
2. No existe limite mximo para o tamanho do arquivo.
Resposta
HTTP/1.1 200 OK
Possveis erros:
Status
Descrio
400
application/XML
Formato contedo
403
application/xml
404
Protocolo no encontrado
10
Verso 1.1.9
Especificao
Requisio
GET /staws/arquivos/{protocolo}/posicaoupload HTTP/1.1
onde:
Transmisso no iniciada;
Transmisso finalizada; ou
Transmisso pendente.
Possveis erros:
Status
Descrio
Formato contedo
400
application/XML
403
application/xml
11
Verso 1.1.9
inicio-fim/total: byte inicial, byte final e tamanho total o arquivo, sendo que os
parmetros inicio e fim so obrigatrios; e
Status
400
Descrio
Ocorreu algum erro. Verificar mensagem dentro do
XML de retorno.
12
Formato contedo
application/XML
404
Protocolo no encontrado
410
416
501
Verso 1.1.9
application/xml
application/xml
application/xml
6 Download de arquivos
O servio de download do STA suporta diversas funcionalidades previstas na
especificao do protocolo HTTP, sendo possvel realizar:
1. Download completo para efetuar download de arquivo em uma s parte;
2. Retomada de download (resume) para retomar download interrompido do
ponto onde parou;
3. Download em paralelo para permitir reduo significativa no tempo de
download, ao possibilitar a recepo de vrias partes do mesmo arquivo ao
mesmo tempo; e
4. Download de parte de arquivo permite efetuar download de uma parte
especfica do arquivo, informando-se a posio inicial e final (range).
Ateno: Ao utilizar o download em paralelo, no se esquea dos limites de conexes abertas
descritas na seo 2.8 Limites de conexes.
Importante: Apesar do protocolo HTTP possibilitar passar vrios intervalos (ranges) na mesma
requisio, essa funcionalidade no est implementada no STA. Se desejar baixar diversos
intervalos, utilize uma requisio para cada um.
Especificao
Requisio
GET /staws/arquivos/{protocolo}/conteudo HTTP/1.1
onde:
13
Verso 1.1.9
Resposta
HTTP/1.1 200 OK
ETag: {etag}
Last-Modified: {data_modificacao_arquivo}
X-Content-Hash: SHA-256 {hash_arquivo}
{contedo_arquivo}
onde:
Status
Descrio
400
404
Protocolo no encontrado
410
Formato contedo
application/xml
application/xml
14
Verso 1.1.9
recebida
em
15
data_modificacao_arquivo: data
especificao do HTTP [3];
da
ltima
modificao,
conforme
Verso 1.1.9
Possveis erros:
Status
Descrio
400
404
Protocolo no encontrado
410
412
416
501
Formato contedo
application/xml
application/xml
application/xml
7 Alterao de situao
Esse servio tem o propsito de alterar a situao de um arquivo. A situao pode ser
alterada para:
1. A receber altera um arquivo marcado como Recebido para A receber; e
2. Recebido altera um arquivo marcado como A receber para Recebido.
Essa funcionalidade ser utilizada tipicamente em casos quando um operador faz o
download de um arquivo que deveria ser entregue a outro da mesma instituio. Dessa
forma, ele poder alterar a situao para o estado anterior. Pode-se fazer uma analogia
funcionalidade Marcar como no lido dos softwares de email.
A alterao para Recebido tipicamente servir para excluir um ou mais protocolos da
consulta a arquivos a receber pela instituio.
Observao: Ao ser baixado por meio da funcionalidade de download, o arquivo tem
sua situao alterada automaticamente de A receber para Recebido.
Veja tambm Tabela 8: Mensagens de erro de alterao da situao de
arquivo.
16
Verso 1.1.9
7.1 Especificao
Requisio
PUT /staws/arquivos/situacao HTTP/1.1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Parametros>
<Protocolos>1;2</Protocolos>
<Situacao>A_REC</Situacao>
</Parametros>
Ateno: O Content-Type deve ser application/xml.
Informaes importantes:
1. O elemento Protocolos recebe uma lista de protocolos separados por ; (ponto-evrgula).
2. O elemento Situacao informa para qual situao se quer alterar os protocolos
informados. Pode conter os valores:
a. A_REC a receber; e
b. REC recebido;
Resposta
HTTP/1.1 204 No Content
Possveis erros:
Status
400
Descrio
Houve algum erro. Verificar mensagem dentro do
XML de retorno.
Formato contedo
application/xml
17
Verso 1.1.9
Especificao
Requisio
GET /staws/arquivos/disponiveis?dependencia={dependencia}&
dataHoraInicio={inicio}&identificadorDocumento={identificador}
&sistemas={sistemas} HTTP/1.1
Ateno:
1. A requisio no deve conter o header Content-Type.
Observao: verifique a descrio e obrigatoriedade de cada parmetro na Tabela 4:
Parmetros da Consulta a arquivos disponveis.
Resposta
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resultado xmlns:atom="http://www.w3.org/2005/Atom">
<DataHoraProximaConsulta>2012-07-25T10:00:00.001</DataHoraProximaConsulta>
<Arquivo>
<Protocolo>3</Protocolo>
<TipoArquivo>ACOS011</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<Sistema>CCS</Sistema>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<DataHoraDisponibilizacao>2012-07-21T10:00:00.000</DataHoraDisponibilizacao>
</Arquivo>
<Arquivo>
<Protocolo>1</Protocolo>
<TipoArquivo>ACOS011</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
18
Verso 1.1.9
<Sistema>CCS</Sistema>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<DataHoraDisponibilizacao>2012-07-23T10:00:00.000</DataHoraDisponibilizacao>
</Arquivo>
<Arquivo>
<Protocolo>2</Protocolo>
<TipoArquivo>ACOS011</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<Sistema>CCS</Sistema>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<DataHoraDisponibilizacao>2012-07-25T10:00:00.000</DataHoraDisponibilizacao>
</Arquivo>
<atom:link href="https://{host}/staws/arquivos/disponiveis?dataHoraInicio=
{data}&sistemas={sist}&unidade={unidade}&dependencia={dep}" rel="disponiveis"
type="application/octet-stream"/>
</Resultado>
Informaes importantes:
1. O elemento DataHoraProximaConsulta que est no formato yyyy-MMddTHH:mm:ss.SSS, ser:
i. Um milissegundo a mais que a ltima consulta, caso a consulta tenha
resultados;
ii. A prpria dataHoraInicio passado como parmetro da pesquisa, caso a
consulta no tenha resultado;
iii. A DataHoraDisponibilizacao da prxima consulta caso existam mais
que 1.000 registros.
2. O valor do elemento DataHoraDisponibilizacao est formatado yyyy-MMddTHH:mm:ss.SSS;
Observao: essa uma consulta paginada e trar no mximo 1.000 protocolos. Se existir
mais que 1.000 protocolos, o resultado conter um elemento atom:link contendo a url a ser
utilizada para a recuperao da prxima pgina.
Possveis erros:
Status
Descrio
400
Formato contedo
application/xml
19
Verso 1.1.9
Especificao
Requisio
GET /staws/arquivos?tipoConsulta=PROT&nivelDetalhe={nivel}
&protocolos={protocolos}&origemResposta={origemResposta} HTTP/1.1
Ateno: A requisio no deve conter o header Content-Type.
Observao: verifique a descrio e obrigatoriedade de cada parmetro na Tabela 1:
Parmetros da Consulta por protocolos.
Resposta
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resultado>
<Arquivo>
<Protocolo>1</Protocolo>
<TipoArquivo>XPTO</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<EstadoAtual>
<Codigo>1</Codigo>
<DataHora>2012-01-01T10:25:00</DataHora>
</EstadoAtual>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
</Arquivo>
<Arquivo>
<Protocolo>2</Protocolo>
<TipoArquivo>XPTO</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<EstadoAtual>
<Codigo>1</Codigo>
<DataHora>2012-01-01T10:25:00</DataHora>
</EstadoAtual>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<Respostas>
<Protocolo>3</Protocolo>
<Protocolo>4</Protocolo>
</Respostas>
</Arquivo>
</Resultado>
Possveis erros:
Status
Descrio
400
Formato contedo
application/xml
20
Verso 1.1.9
Possveis erros:
Status
Descrio
400
Formato contedo
application/xml
21
Verso 1.1.9
9 Senha
Com o uso do STA, comum a necessidade de gerenciar senhas de forma automtica.
Por este motivo, o sistema dispe de 2 servios: alterao de senha e consulta vencimento
de senha.
Os servidores para acesso aos Web Services de senha so:
Ambiente de homologao: https://www9.bcb.gov.br/senhaws
Ambiente de produo: https://www3.bcb.gov.br/senhaws
Especificao
Requisio
PUT https://www9.bcb.gov.br/senhaws/senha HTTP/1.1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Parametros>
<Senha>{senha}</Senha>
<NovaSenha>{novasenha}</NovaSenha>
<ConfirmacaoNovaSenha>{novasenha}</ConfirmacaoNovaSenha>
</Parametros>
Ateno: O Content-Type deve ser application/xml.
Onde:
Resposta
HTTP/1.1 204 No Content
Possveis erros:
Status
400
Descrio
Houve algum erro. Verificar mensagem dentro do
XML de retorno.
Formato contedo
application/xml
22
Verso 1.1.9
9.2.1
Especificao
Requisio
GET https://www9.bcb.gov.br/senhaws/senha/vencimento HTTP/1.1
Resposta
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resultado>
<DiasVencimentoSenha>{diasVencimentoSenha}</DiasVencimentoSenha>
</Resultado>
Onde:
Possveis erros:
Status
400
Descrio
Houve algum erro. Verificar mensagem dentro do
XML de retorno.
Formato contedo
application/xml
23
Verso 1.1.9
24
Verso 1.1.9
Uma tela com o detalhamento completo de cada requisio selecionada ser aberta.
25
Verso 1.1.9
URI: URI (tambm conhecida como URL) para onde foi feita a requisio,
precedida do mtodo HTTP utilizado;
12 Referncias
de
os
algoritmos
de
hash
SHA2:
13 Suporte
Dvidas e problemas no STA podero ser tratados pelo help desk do Banco Central
no telefone (61) 3414-2156 ou encaminhadas por e-mail para suporte.ti@bcb.gov.br.
26
Verso 1.1.9
Descrio
tipoConsulta
Obrigatrio
nivelDetalhe
Obrigatrio
protocolos
Obrigatrio
origemResposta
Opcional
27
Verso 1.1.9
Descrio
tipoConsulta
Obrigatrio
nivelDetalhe
Obrigatrio
dependencia
Opcional
dataHoraInicio
Obrigatrio caso
dataHoraFim
tenha sido
informada
dataHoraFim
Opcional
codigoEstado
Opcional
identificadorDocumento
Opcional
situacaoTransmissao
Opcional
Significado
REC
A_REC
Opcional
ordenacao
Opcional
28
Verso 1.1.9
Significado
PROT_ASC
PROT_DESC
DH_ASC
DH_DESC
Opcional
29
Verso 1.1.9
30
Descrio
Protocolo gerado
Transmisso iniciada
10
Transmisso finalizada
15
20
25
30
35
Arquivo aceito
45
Arquivo cancelado
55
Arquivo inconsistente
65
Arquivo rejeitado
70
Download iniciado
75
Download finalizado
Verso 1.1.9
Descrio
Cdigo Sisbacen de uma dependncia da
instituio do usurio da consulta.
Data e hora inicial no formato yyyy-MMddTHH:mm:ss.SSS
dependencia
Opcional
dataHoraInicio
Obrigatrio
identificadorDocumento
Opcional
sistemas
Opcional
31
Verso 1.1.9
Mensagem
Motivo
400
400
400
400
400
400
400
400
400
400
32
Verso 1.1.9
Mensagem
Motivo
400
400
Protocolo em branco
400
400
Protocolo no numrico
400
O protocolo informado
negativo ou zero.
400
33
Verso 1.1.9
Mensagem
Motivo
400
Parmetro
'IdentificadorDocumento'
no informado
400
Parmetro
'IdentificadorDocumento'
invlido
403
Usurio no autorizado a
transmitir o arquivo #####
1. O identificador do documento no um
cdigo de documento nem um nome de
arquivo cadastrado no sistema.
2. O identificador do documento informado no
est disponvel para downlod/upload.
O usurio no est cadastrado no servio de acesso
associado ao identificador de documento informado.
400
Parmetro 'Hash' no
informado
400
400
Parmetro 'Tamanho' no
informado
400
34
Verso 1.1.9
Mensagem
Motivo
400
400
O parmetro Situacao
passado no XML no
corresponde a A_REC ou
REC.
400
Protocolo invlido
O protocolo informado no
pertence instituio
400
400
35
Verso 1.1.9
Informaes importantes:
1. O elemento Arquivo repetir conforme a quantidade de registros obtidos no
resultado;
2. O valor do elemento DataHora est formatado no padro ISO 8601 [4];
3. O elemento Respostas s existir caso o protocolo tenha respostas
associadas;
4. O elemento Protocolo, subelemento de Respostas, repetir conforme a
quantidade de respostas geradas para o protocolo;
5. O elemento ProtocoloOrigem s existir caso se trate de arquivo de resposta;
6. Caso o parmetro origemResposta seja RESP, o retorno conter apenas o
detalhamento dos arquivos de resposta aos protocolos informados. Caso o
parmetro origemResposta seja PROT_RESP, o retorno conter tanto o
detalhamento dos protocolos informados quanto o dos arquivos de resposta
gerados para os mesmos.
36
Verso 1.1.9
Informaes importantes:
1. Todas as informaes da transferncia do arquivo;e
2. Os elementos destacados em negrito so aqueles que no so retornados no
nvel de detalhe resumido
37
Verso 1.1.9
Informaes importantes:
1. Todas as informaes sobre a transferncia de arquivo, associadas ao
histrico de auditoria;e
2. O elemento Historico repetir conforme a quantidade registros referentes a
mudanas de estado do arquivo.
38
Verso 1.1.9
Informaes importantes:
1. O valor do elemento Codigo ser o cdigo de status HTTP do retorno.
2. O elemento Descricao explica o motivo do erro.
39
Verso 1.1.9
40