You are on page 1of 40

Sistema de Transferncia de Arquivos

Manual de utilizao dos


Web Services do STA
Verso 1.1.9

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Sumrio
1

Introduo .............................................................................................................................. 4

Segurana ............................................................................................................................. 4
2.1

Autorizao de uso ........................................................................................................ 4

2.2

Acesso em homologao .............................................................................................. 4

2.3

Autenticao de usurio ................................................................................................ 5

2.4

Formato do login do usurio .......................................................................................... 5

2.5

Trfego seguro .............................................................................................................. 5

2.6

Integridade dos arquivos ............................................................................................... 5

2.7

Requisitos tcnicos........................................................................................................ 6

2.8

Limites de conexes ...................................................................................................... 6

Requisio HTTP completa ................................................................................................... 6

Teste de conectividade ......................................................................................................... 6

Upload de arquivos................................................................................................................ 7
5.1

Requisio de protocolo ................................................................................................ 7

5.1.1
5.2

Upload completo.......................................................................................................... 10

5.2.1
5.3

Retomada de upload (resume).................................................................................... 12

5.5

Upload em paralelo ..................................................................................................... 12

5.6

Upload de parte de arquivo ......................................................................................... 12

Download de arquivos ......................................................................................................... 13


Download completo ..................................................................................................... 13

6.1.1

Especificao .......................................................................................................... 13

6.2

Retomada de download (resume) ............................................................................... 14

6.3

Download em paralelo ................................................................................................. 15

6.4

Download de parte do arquivo .................................................................................... 15

Alterao de situao .......................................................................................................... 16


7.1

Especificao .......................................................................................................... 11

5.4

6.1

Especificao .......................................................................................................... 10
Consulta a posio do upload ..................................................................................... 11

5.3.1

Especificao ............................................................................................................ 8

Especificao .............................................................................................................. 17

Consulta a transferncias de arquivos ................................................................................ 17

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA


8.1

Consulta arquivos disponveis ..................................................................................... 18

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

Consulta histrico de requisies Web Services ................................................................ 23

11

Teste de envio/recebimento de arquivo .............................................................................. 26

12

Referncias ......................................................................................................................... 26

13

Suporte ................................................................................................................................ 26

Tabela 1: Parmetros da Consulta por protocolos...................................................................... 27


Tabela 2: Parmetros da Consulta avanada ............................................................................. 28
Tabela 3: Valores para o parmetro codigoEstado .................................................................. 30
Tabela 4: Parmetros da Consulta a arquivos disponveis ......................................................... 31
Tabela 5: Mensagens de erro de consultas ................................................................................ 32
Tabela 6: Mensagens de erro relacionadas a protocolo ............................................................. 33
Tabela 7: Mensagens de erro de envio de arquivos (upload)..................................................... 34
Tabela 8: Mensagens de erro de alterao da situao de arquivo ........................................... 35
Listagem 1: Formato XML com nvel de detalhe Resumido .................................................... 36
Listagem 2: Formato XML com nvel de detalhe Bsico ......................................................... 37
Listagem 3: Formato XML com nvel de detalhe Completo ..................................................... 38
Listagem 4: Formato XML da mensagem de erro...................................................................... 39
Anexo 1: Fluxo de estados no envio de arquivos ....................................................................... 40

Banco Central do Brasil, 2015

Verso 1.1.9

Manual de utilizao dos Web Services do STA

Manual de utilizao dos Web


Services do STA
1 Introduo
Este manual trata da utilizao dos Web Services do Sistema de Transferncia de
Arquivos STA, desenvolvido para substituir o aplicativo PSTAC10.
Os Web Services desenvolvidos tm por objetivo permitir a automatizao de:
1. Consultas a arquivos transferidos ou disponveis para download;
2. Envio de arquivos (upload); e
3. Recebimento de arquivos (download).
Para realizar transferncia de arquivos manualmente, utilize a interface Web do STA.
Maiores informaes podem ser obtidas no manual de utilizao do STA Web.

Web Services providos


(REpresentational State Transfer).
Os

pelo

STA

seguem

padro

REST

Os servidores para acesso aos Web Services do STA so:


Ambiente de homologao: https://sta-h.bcb.gov.br/staws
Ambiente de produo: https://sta.bcb.gov.br/staws

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.

2.2 Acesso em homologao


Para participar da homologao do STA, observamos que necessrio ter usurio
cadastrado no Sisbacen de homologao e credenciado na transao PSTA300 no mesmo
ambiente. Tal credenciamento deve ser feito pelo mster Sisbacen de cada instituio.

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

Manual de utilizao dos Web Services do STA

Verso 1.1.9

(https://www3.bcb.gov.br/bccorreio). O remetente, que deve necessariamente ser mster no


ambiente de produo, deve informar o email para o qual ser enviada a nova senha.
Aps a verificao de que o solicitante realmente mster Sisbacen no ambiente de
produo, sua senha do ambiente de homologao ser alterada e enviada para o email
indicado no correio eletrnico.
O mster da instituio deve ento disponibilizar a transao PSTA300 a usurios, via
PTRA700, no ambiente transacional do Sisbacen ou Autranweb, ambos de homologao.
Para acessar o Sisbacen de homologao, acesse a tela principal do Sisbacen e digite
HOMOLOGA no campo TRANSACAO e tecle Entra. Aps isso, a navegao idntica ao
Sisbacen de produo.

2.3 Autenticao de usurio


A autenticao do usurio nos Web Services realizada via Basic Authentication. Para
referncia sobre este mtodo de autenticao, consulte a especificao [2].

2.4 Formato do login do usurio


Certifique-se que o login
UUUUUDDDD.operador, onde:

usado

na

requisio

est

no

formato

UUUUU Cdigo Sisbacen da sua instituio


DDDD Cdigo Sisbacen da sua dependncia
operador Seu nome de usurio

2.5 Trfego seguro


Todo o trfego de informaes realizado utilizando o protocolo HTTPS, que o padro
da Web para trafegar dados de maneira segura.
A conexo HTTPS criptografada e a autenticidade do servidor verificada atravs de
certificado digital.

2.6 Integridade dos arquivos


A integridade do contedo do arquivo verificada utilizando-se algoritmo de hash, que
garante que o contedo recebido o mesmo que foi enviado.

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

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].

2.7 Requisitos tcnicos


A plataforma de desenvolvimento do cliente dos Web Services deve ter suporte a:

HTTP 1.1
HTTPS
Leitura e manipulao de documentos XML.

2.8 Limites de conexes


Alguns limites foram estabelecidos para o nmero de conexes ao STA. Os limites
foram estabelecidos por instituio e no por usurio. A tabela a seguir informa quais so
esses limites:

Funcionalidade

Limite por instituio

Upload e Download

Mximo de 10 simultneos

Consulta

Mximo de 5 por minuto

Comando

Mximo de 5 por minuto

3 Requisio HTTP completa


Uma requisio HTTP completa para os Web Services do STA, devem conter os headers
abaixo.
Requisio
GET /staws/arquivos?tipoConsulta=AVANC&nivelDetalhe=RES HTTP/1.1
Host: sta-h.bcb.gov.br
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Connection: keep-alive

Importante: o usurio e senha contidos no header Authorization so fictcios. Eles


devem ser substitudos por usurio e senha vlidos, conforme sees 2.3 Autenticao de
usurio e 2.4 Formato do login do usurio.
Todos os exemplos apresentados nesse manual foram simplificados para mostrarem
apenas os cabealhos mais relevantes.

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:

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

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:

2.1 Autorizao de uso,


2.2 Acesso em homologao (no o mesmo usurio de produo) e
2.4 Formato do login do usurio (UUUUUDDDD.operador).

O resultado deve ser semelhante tela seguinte:

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).

5.1 Requisio de protocolo


Fornece um identificador nico (protocolo) para o novo arquivo a ser enviado.

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA


5.1.1

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:

tipo_arquivo: nome ou cdigo de documento do tipo do arquivo que ser


transmitido (ex.: ACOS011 ou 4010);

hash_sha256: hash calculado sobre o arquivo realmente transmitido. Se


o arquivo estiver compactado, deve ser calculado aps a
compactao;

tamanho_arquivo: tamanho em bytes do arquivo realmente transmitido.


Se o arquivo estiver compactado, deve ser o tamanho aps a
compactao;

nome_arquivo: nome original do arquivo; e

observao : Opcional. Observao sobre o arquivo a transferir.

Ateno: O Content-Type deve ser application/xml.


Resposta
HTTP/1.1 201 Created
Location: https://{host}/staws/arquivos/{protocolo}/conteudo
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resultado xmlns:atom="http://www.w3.org/2005/Atom">
<Protocolo>{protocolo}</Protocolo>
<atom:link
href="https://{host}/staws/arquivos/{protocolo}/conteudo"
rel="conteudo" type="application/octet-stream" />
</Resultado>
onde:

host: Nome do host do ambiente onde a requisio foi processada.


Em homologao ser sta-h.bcb.gov.br; e
protocolo: Nmero do protocolo gerado para a transmisso do arquivo.

Possveis erros:

Status

Descrio

Formato contedo
Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA


400

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

Verso 1.1.9

application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela 5:


Mensagens de erro de consultas.

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

5.2 Upload completo


5.2.1

Especificao

Requisio
PUT /staws/arquivos/{protocolo}/conteudo HTTP/1.1
{contedo_arquivo}
onde:

protocolo: nmero do protocolo obtido em requisio feita anteriormente


(seo 5.1 Requisio de protocolo); e

contedo_arquivo: stream contendo os dados do arquivo;

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

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

application/XML

Formato contedo

403

Protocolo no pertence instituio

application/xml

404

Protocolo no encontrado

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela 5:


Mensagens de erro de consultas.

10

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

5.3 Consulta a posio do upload


O resultado dessa consulta contm a lista das partes de um arquivo que j foram
enviadas com sucesso ao Banco Central do Brasil.
Ela deve ser utilizada antes de retomar um upload interrompido.
5.3.1

Especificao

Requisio
GET /staws/arquivos/{protocolo}/posicaoupload HTTP/1.1
onde:

protocolo: nmero do protocolo obtido em requisio feita anteriormente


(seo 5.1 Requisio de protocolo).

Ateno: A requisio no deve conter o header Content-Type.


Resposta
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resultado>
<Protocolo>1</Protocolo>
<RangesRecebidos>0-3;5-8</RangesRecebidos>
<Situacao>Transmisso pendente</Situacao>
</Resultado>
Informaes importantes:
1. O contedo do elemento RangesRecebidos contm uma lista separada por
ponto-e-vrgula (;) e com caractere hfen (-) separando o incio do intervalo do
final. Por exemplo: 0-3;5-8.
2. O contedo do elemento Situacao contm um dos seguintes valores:

Transmisso no iniciada;
Transmisso finalizada; ou
Transmisso pendente.

Possveis erros:
Status

Descrio

Formato contedo

400

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

application/XML

403

Protocolo no pertence instituio.

application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela


5: Mensagens de erro de consultas.

11

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

5.4 Retomada de upload (resume)


Caso a conexo seja interrompida durante o envio do arquivo (upload), possvel
realizar o upload da parte do arquivo que ainda falta ser enviada. Para isso, utilize a requisio
descrita na seo 5.6- Upload de parte de arquivo.
Ateno: importante realizar a consulta descrita na seo 5.3 Consulta a posio do upload
antes de realizar a retomada da transmisso. Em caso de erro de conexo, no h garantia
que todo o contedo enviado foi recebido pelo Banco Central.

5.5 Upload em paralelo


possvel efetuar a transferncia de diferentes partes de um arquivo em paralelo com
o objetivo de reduzir o tempo total de transmisso. Para tanto, utilize o tipo de requisio
descrito na seo 5.6 Upload de parte de arquivo.
Ateno: Ao utilizar o upload em paralelo, no se esquea dos limites de conexes abertas
descritas na seo 2.8 Limites de conexes.
Importante: O parmetro {protocolo} o mesmo para transmisso completa ou transmisso
em partes.

5.6 Upload de parte de arquivo


Requisio
PUT /staws/arquivos/{protocolo}/conteudo HTTP/1.1
Content-Range: bytes {inicio-fim/total}
{contedo_arquivo}
onde:

protocolo: nmero do protocolo obtido em requisio feita anteriormente


(seo 5.1 Requisio de protocolo);

inicio-fim/total: byte inicial, byte final e tamanho total o arquivo, sendo que os
parmetros inicio e fim so obrigatrios; e

contedo_arquivo: stream contendo o contedo do arquivo.

Ateno: A requisio no precisa conter o header Content-Type. Caso informado, no


permitido multipart/form-data.
Resposta
HTTP/1.1 200 OK
Observao: Para referncia sobre o uso dos cabealhos HTTP 1.1, consulte a especificao
[3].
Possveis erros:

Status
400

Descrio
Ocorreu algum erro. Verificar mensagem dentro do
XML de retorno.

12

Formato contedo
application/XML

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA


403

Protocolo no pertence instituio

404

Protocolo no encontrado

410

O protocolo informado foi cancelado pelo Banco


Central do Brasil

416

O range informado invlido

501

O range multipart no suportado.

Verso 1.1.9

application/xml

application/xml

application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela 5:


Mensagens de erro de consultas.

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.

6.1 Download completo


6.1.1

Especificao

Requisio
GET /staws/arquivos/{protocolo}/conteudo HTTP/1.1
onde:

protocolo: nmero do protocolo do arquivo desejado.

Ateno: A requisio no deve conter o header Content-Type.

13

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

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:

etag: etag do arquivo;

data_modificacao_arquivo: data da ltima modificao do arquivo

hash_arquivo: hash SHA-256 do arquivo; e

contedo_arquivo: stream contendo os dados do arquivo.

Observao: o cabealho X-Content-Hash no um padro do HTTP. Ele foi criado pelo


Banco Central do Brasil para ser utilizado na validao da integridade do arquivo recebido
atravs de um algoritmo de hash forte (SHA-256).
Observao 2: para referncia sobre o uso dos cabealhos HTTP 1.1, consulte a
especificao [3].
Possveis erros:

Status

Descrio

400

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

404

Protocolo no encontrado

410

O arquivo no est disponvel para download.

Formato contedo
application/xml

application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela 5:


Mensagens de erro de consultas.

6.2 Retomada de download (resume)


Caso a conexo seja interrompida durante o download, possvel retom-lo da parte
do arquivo que ainda falta baixar. Para isso, utilize a requisio descrita na seo 6.4Download de parte do arquivo, informando o intervalo de bytes do arquivo que ainda no foi
baixado.

14

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

6.3 Download em paralelo


possvel efetuar a transferncia de diferentes partes de um arquivo em paralelo com
o objetivo de reduzir o tempo total de transmisso. Para tanto, utilize o tipo de requisio
descrito na seo 6.4- Download de parte do arquivo.
Ateno: Ao utilizar o download em paralelo, no se esquea dos limites de conexes abertas
descritas na seo 2.8 Limites de conexes.

6.4 Download de parte do arquivo


Requisio
GET /staws/arquivos/{protocolo}/conteudo HTTP/1.1
Range: bytes={inicio-fim}
If-Match: {etag}
If-Unmodified-Since: {data_modificacao_arquivo}
onde:

protocolo: nmero do protocolo do arquivo desejado;

inicio-fim: byte inicial e byte final da parte;

etag: ETag recebido em requisio anterior, conforme a especificao do


HTTP [3]; e

data_modificacao_arquivo: data de ltima modificao


requisio anterior, conforme a especificao do HTTP [3.

recebida

em

Ateno: A requisio no deve conter o header Content-Type.


Observao: os cabealhos If-Match e If-Unmodified-Since so opcionais.
Resposta
HTTP/1.1 206 Partial Content
ETag: {etag}
Last-Modified: {data_modificacao_arquivo}
X-Content-Hash: SHA-256 {hash_arquivo}
{conteudo_arquivo}
onde:

15

etag: ETag, conforme a especificao do HTTP [3];

data_modificacao_arquivo: data
especificao do HTTP [3];

hash_arquivo: hash do arquivo; e

conteudo_arquivo: stream contendo o contedo do arquivo.

da

ltima

modificao,

conforme

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Possveis erros:

Status

Descrio

400

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

404

Protocolo no encontrado

410

O arquivo no est disponvel para download.

412

Validao dos cabealhos If-Match e IfUnmodified-Since falhou

416

Range informado invlido

501

O range multipart no suportado.

Formato contedo
application/xml

application/xml

application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela


5: Mensagens de erro de consultas.

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

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

Veja tambm Listagem 4: Formato XML da mensagem de erro e Tabela


5: Mensagens de erro de consultas.

8 Consulta a transferncias de arquivos


possvel consultar a transferncias de arquivos enviados, recebidos, a receber e
disponveis.
Existem trs tipos de consulta:
1. Arquivos disponveis recupera os arquivos disponibilizados a partir de uma
data-hora informada.
2. Por protocolos recupera informaes de arquivos a partir de protocolos
informados;
3. Avanada - recupera informaes a partir de parmetros que sero utilizados
para filtrar a consulta.
Adicionalmente, para consulta por protocolo e avanada, o usurio poder informar o
nvel de detalhamento do retorno da consulta. Os nveis de detalhes podero ser:

17

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

a) RES (Resumido) retorna apenas as informaes mais relevantes sobre a


transferncia do arquivo;
b) BAS (Bsico) retorna todas as informaes da transferncia do arquivo
exceto o histrico de auditoria; e
c) COMPL (Completo) - retorna todas as informaes da transferncia do
arquivo.
Para cada tipo de consulta, ser descrita a interao entre o cliente e o servio.
Observao: o detalhamento das informaes de cada um dos nveis est descrito em:

Listagem 1: Formato XML com nvel de detalhe Resumido


Listagem 2: Formato XML com nvel de detalhe Bsico
Listagem 3: Formato XML com nvel de detalhe Completo

Veja tambm Tabela 5: Mensagens de erro de consultas.

8.1 Consulta arquivos disponveis


Recupera os arquivos disponibilizados a partir de uma data-hora informada.
8.1.1

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

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

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

Formato contedo
application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro , Tabela


5: Mensagens de erro de consultas e Tabela 4: Parmetros da Consulta a
arquivos disponveis.

19

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

8.2 Consulta por protocolos


Recupera informaes de arquivos transmitidos a partir de protocolos informados.
8.2.1

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

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

Formato contedo
application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro , Tabela


5: Mensagens de erro de consultas e Tabela 1: Parmetros da Consulta por
protocolos.

20

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

8.3 Consulta avanada


Recupera informaes a partir de parmetros que sero utilizados para filtrar a
consulta.
Ateno: Para consultar arquivos disponveis para download, utilize preferencialmente a
consulta descrita na seo 8.1- Consulta arquivos disponveis, uma vez que a consulta
avanada com o parmetro situacaoTransmissao = A_REC sujeita a erros. possvel que
a aplicao no detecte um arquivo disponibilizado pelo Bacen. Isso acontece quando um
usurio recebe um arquivo manualmente fazendo com que a situao do arquivo mude de A
Receber para Recebido. A partir desse momento, o arquivo recebido passa a no constar na
resposta da consulta avanada a arquivos a receber .
Requisio
GET /staws/arquivos?tipoConsulta=AVANC&nivelDetalhe={nivel}
&dependencia={dependencia}&dataHoraInicio={inicio}&dataHoraFim={fim}
&identificadorDocumento={identificador}&situacaoTransmissao={situao}
&qtdMaxResultados={qtd}&ordenao={ordenao} HTTP/1.1
Ateno: A requisio no deve conter o header Content-Type.
Observao: Verifique a descrio e obrigatoriedade de cada parmetro na Tabela 2:
Parmetros da Consulta avanada.
Resposta
Idntica resposta da consulta por protocolos.

Possveis erros:

Status

Descrio

400

Ocorreu algum erro. Verificar mensagem dentro do


XML de retorno.

Formato contedo
application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro , Tabela


5: Mensagens de erro de consultas e Tabela 2: Parmetros da Consulta
avanada.

21

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

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

9.1 Alterao de senha


Esse servio tem o propsito de permitir a alterao de senha do usurio da requisio.
9.1.1

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:

senha a senha atual do usurio da requisio;


novasenha a nova senha que se quer atribuir ao usurio

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

Veja tambm Listagem 4: Formato XML da mensagem de erro.

22

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

9.2 Consulta vencimento de senha


Esse servio tem o propsito de permitir a consulta a quantidade de dias restantes para
o vencimento da senha do usurio autenticado.

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:

diasVencimentoSenha dias restantes para o vencimento da senha;

Possveis erros:

Status
400

Descrio
Houve algum erro. Verificar mensagem dentro do
XML de retorno.

Formato contedo
application/xml

Veja tambm Listagem 4: Formato XML da mensagem de erro.

10 Consulta histrico de requisies Web Services


Esta consulta permite ao usurio acompanhar as requisies e respostas Web Services
realizadas.
O acesso interface Web do STA, em ambiente de homologao, deve ser
feito no endereo https://sta-h.bcb.gov.br/sta.
Para acessar a funcionalidade de consulta ao histrico de requisies Web Services,
no menu superior Consulta, clique na opo Histrico de requisies Web Services,
conforme a tela abaixo:

23

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

A tela exibida apresentar os parmetros de consulta, que devero ser preenchidos


para encontrar as requisies desejadas.

Preenchidos os parmetros, pressione o boto Pesquisar. O resultado da consulta ser


apresentado:

24

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Ao encontrar as requisies desejadas, marque suas respectivas caixas de seleo (ao


lado esquerdo) e pressione o boto Detalhar ao final da pgina.

Uma tela com o detalhamento completo de cada requisio selecionada ser aberta.

Na tela de detalhamento, podem-se visualizar os seguintes campos:

25

Tipo: tipo de requisio, na categorizao do STA (Consulta, Comando,


Upload ou Download);

Resultado: HTTP Status da resposta;

Incio: data e hora do incio da requisio;

Fim: data e hora do final da requisio;

Protocolo: protocolo associado requisio quando houver;


Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Requisitante: login do usurio que fez a requisio;

URI: URI (tambm conhecida como URL) para onde foi feita a requisio,
precedida do mtodo HTTP utilizado;

Header requisio: cabealhos HTTP da requisio. Ateno: alguns deles


so adicionados pelo Proxy do BCB, mas contm informaes importantes,
como IP do requisitante;

Requisio: contedo da requisio at o limite de 1000 bytes (dados binrios


no sero apresentados);

Header resposta: cabealhos HTTP da resposta; e

Resposta: contedo da resposta at o limite de 1000 bytes (dados binrios


no sero apresentados).

11 Teste de envio/recebimento de arquivo


O envio de um arquivo associado ao tipo de arquivo ARQTEST (TEST) acarreta a
disponibilizao do mesmo arquivo para download, com outro nmero de protocolo. A nica
diferena que, caso o arquivo enviado no esteja compactado, o arquivo ser compactado
antes da disponibilizao.
Caso se queira validar o retorno de um tipo de arquivo que no faz parte da
homologao integrada, envie um ARQTEST com o contedo igual ao arquivo resposta que
normalmente recebida. Dessa forma, ser possvel homologar o ciclo completo do envio de
arquivos.

12 Referncias

[1] Especificao da famlia


http://tools.ietf.org/html/rfc5754

[2] Especificao da autenticao Basic e Digest:


http://tools.ietf.org/html/rfc2617

[3] Especificao do HTTP 1.1:


http://www.w3.org/Protocols/rfc2616/rfc2616.html

[4] Padro ISO-8601 para datas:


http://en.wikipedia.org/wiki/ISO_8601

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 1: Parmetros da Consulta por protocolos


Parmetro

Descrio

tipoConsulta

Obrigatrio

Especifica o tipo de consulta. Para este


tipo de consulta dever ser PROT.

nivelDetalhe

Obrigatrio

Especifica o nvel de detalhe do retorno.


Valores possveis:

protocolos

Obrigatrio

origemResposta

Opcional

RES para resumido;


BAS para bsico;
COMPL para completo.
Especifica a lista de protocolos a serem
consultados, separados por ponto-e-vrgula
Especifica as informaes de
transferncias associadas aos protocolos
informados. Valores possveis:

RESP para retornar apenas


respostas
PROT_RESP para retornar origem
e resposta;
Quando no informado ir retornar apenas
origem.

27

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 2: Parmetros da Consulta avanada


Parmetro

Descrio

tipoConsulta

Obrigatrio

Especifica o tipo de consulta. Para este


tipo de consulta dever ser AVANC

nivelDetalhe

Obrigatrio

Especifica o nvel de detalhe do retorno.


Valores possveis:
RES para resumido;
BAS para bsico;
COMPL para completo.
Cdigo Sisbacen de uma dependncia da
instituio do usurio da consulta

dependencia

Opcional

dataHoraInicio

Obrigatrio caso
dataHoraFim
tenha sido
informada

Data e hora inicial no formato "yyyy-MMddTHH:mm:ss" (ISO 8601 [4])

dataHoraFim

Opcional

Data e hora final no formato "yyyy-MMddTHH:mm:ss" (ISO 8601 [4])

codigoEstado

Opcional

Cdigo do estado do arquivo


conformeTabela 3: Valores para o
parmetro codigoEstado.
Quando no informado ir retornar
arquivos em qualquer estado.

identificadorDocumento

Opcional

Cdigo do tipo de documento. Pode ser o


cdigo do documento (ex. 4010) ou o
nome do arquivo no sistema (ex.
ACOS011).

situacaoTransmissao

Opcional

Situao atual do arquivo. Valores


possveis:
Valor

Significado

REC

Apenas arquivos recebidos

A_REC

Apenas arquivos a receber

Quando no informado ir retornar


arquivos em qualquer situao.
qtdMaxResultados

Opcional

Quantidade de registros a serem


retornados. A quantidade mxima de
registros retornados cem.

ordenacao

Opcional

Lista de campos a serem usados para


ordenao separados por vrgula (,). Os
valores possveis:

28

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA


Valor

Verso 1.1.9

Significado

PROT_ASC

Por protocolo ascendente

PROT_DESC

Por protocolo descendente

DH_ASC

Por data-hora (de atualizao


do estado do arquivo)
ascendente

DH_DESC

Por data-hora (de atualizao


do estado do arquivo)
descendente

Valor padro: DH_DESC


sistemas

Opcional

Cdigo de 3 caracteres separados por


ponto-e-vrgula. So permitidos 100
sistemas em uma consulta.
O sistema corresponde segunda,
terceira e quarta letra do nome do tipo de
arquivo. Exemplo: ACAM156 corresponde
a sistema CAM.

29

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 3: Valores para o parmetro codigoEstado


Valor

30

Descrio

Protocolo gerado

Arquivo disponvel para download

Transmisso iniciada

10

Transmisso finalizada

15

Arquivo em processo de montagem/validao de formato

20

Arquivo recebido no Bacen

25

Arquivo entregue para o destinatrio

30

Arquivo em processamento pela aplicao

35

Arquivo aceito

45

Arquivo cancelado

55

Arquivo inconsistente

65

Arquivo rejeitado

70

Download iniciado

75

Download finalizado

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 4: Parmetros da Consulta a arquivos disponveis


Parmetro

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

Nome do tipo de arquivo ou cdigo do


documento

sistemas

Opcional

Cdigo de 3 caracteres separados por


ponto-e-vrgula. So permitidos 100
sistemas em uma consulta.
O sistema corresponde segunda, terceira
e quarta letra do nome do tipo de arquivo.
Exemplo: ACAM156 corresponde a
sistema CAM.

31

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 5: Mensagens de erro de consultas


Cdigo

Mensagem

Motivo

400

Parmetro 'TipoConsulta' no informado

400

Parmetro 'NivelDetalhe' no informado

400

Parmetro 'DataHoraInicio' no deve ser


informado para tipo de consulta 'PROT'

Consulta por protocolos no


permite a informao de
DataHoraInicio.

400

Parmetro 'CodigoEstado' no deve ser


informado para tipo de consulta 'PROT'

Consulta por protocolos no


deve informar CodigoEstado.

400

Parmetro 'IdentificadorDocumento' no deve ser


informado para tipo de consulta 'PROT'

Consulta por protocolos no


permite a informao de
IdentificadorDocumento.

400

Parmetro 'SituacaoTransmissao' no deve ser


informado para tipo de consulta 'PROT'

Consulta por protocolos no


permite a informao de
SituacoTransmissao.

400

Parmetro 'Protocolos' no deve ser informado


para tipo de consulta 'AVANC'

Consulta avanada permite a


informao de Protocolos.

400

Parmetro 'OrigemResposta' no deve ser


informado para tipo de consulta 'AVANC'

Consulta avanada permite a


informao de
OrigemResposta.

400

Parmetro '### ' invlido.

Foi passado algum parmetro


no descrito neste manual.

400

Nmero de consultas por minuto excedido.

Foram realizadas mais que 10


consultas no ltimo minuto.

32

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 6: Mensagens de erro relacionadas a protocolo


Cdigo

Mensagem

Motivo

400

Quantidade de protocolos informada ("###")


excede o limite de 100

400

Protocolo em branco

Parmetro Protocolos foi


informado, porm no contm
valores vlidos.

400

Protocolo com tamanho invlido

O protocolo informado possui


mais que 18 dgitos.

400

Protocolo no numrico

O protocolo informado contm


caracteres no numricos.

400

Protocolo menor ou igual a zero

O protocolo informado
negativo ou zero.

400

Protocolo(s) ###, ### e ### no pertence(m)


instituio

O usurio est pesquisando


por arquivos que no lhe
pertencem.

33

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 7: Mensagens de erro de envio de arquivos (upload)


Cdigo

Mensagem

Motivo

400

Parmetro
'IdentificadorDocumento'
no informado

Parmetro 'IdentificadorDocumento' vazio.

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

Parmetro ' Hash ' vazio.

400

Parmetro ' Hash ' invlido

Parmetro Hash no contm 64 caracteres


hexadecimais.

400

Parmetro 'Tamanho' no
informado

Parmetro ' Tamanho ' vazio.

400

Tamanho informado maior


que o permitido

34

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Tabela 8: Mensagens de erro de alterao da situao de


arquivo
Cdigo

Mensagem

Motivo

400

Parmetro 'Situacao' no informado

O parmetro Situacao no foi


informado no XML de entrada.

400

Parmetro 'Situacao' invlido

O parmetro Situacao
passado no XML no
corresponde a A_REC ou
REC.

400

Protocolo invlido

O protocolo informado no
pertence instituio

400

Alterao de situao do protocolo NNN no


permitida.

Os arquivos s podem ser


alterados quando sua
situao atual for a receber
ou recebido.

400

Nmero de comandos por minuto excedido.

Foram realizadas mais que 10


solicitaes de alterao de
situao em um perodo de 1
minuto.

35

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Listagem 1: Formato XML com nvel de detalhe Resumido


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resultado>
<Arquivo>
<Protocolo>1</Protocolo>
<TipoArquivo>XPTO</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<EstadoAtual>
<DataHora>2012-01-01T10:25:00</DataHora>
<Codigo>1</Codigo>
</EstadoAtual>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<Respostas>
<Protocolo>2</Protocolo>
</Respostas>
</Arquivo>
<Arquivo>
<Protocolo>2</Protocolo>
<TipoArquivo>XPTO</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<EstadoAtual>
<DataHora>2012-01-01T10:25:00</DataHora>
<Codigo>1</Codigo>
</EstadoAtual>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<ProtocoloOrigem>1</ProtocoloOrigem>
</Arquivo>
</Resultado>

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Listagem 2: Formato XML com nvel de detalhe Bsico


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Arquivo>
<Protocolo>1</Protocolo>
<TipoArquivo>XPTO</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<EstadoAtual>
<DataHora>2012-01-01T10:25:00</DataHora>
<Codigo>1</Codigo>
<Descricao>Protocolo gerado</Descricao>
<CodigoDescricaoComplementar>2</CodigoDescricaoComplementar>
<DescricaoComplementar>descricao</DescricaoComplementar>
</EstadoAtual>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<Emissor>
<Unidade>99999</Unidade>
<Dependencia>0000</Dependencia>
<Operador>teste</Operador>
<NomeInstituicao>IF Teste</NomeInstituicao>
</Emissor>
<Destinatario>
<Unidade>99999</Unidade>
<Dependencia>0000</Dependencia>
<Operador>teste</Operador>
<NomeInstituicao>IF Teste</NomeInstituicao>
</Destinatario>
<Respostas>
<Protocolo>2</Protocolo>
</Respostas>
<TamanhoArquivo>10</TamanhoArquivo>
<NomeArquivoOrigem>nomeArquivo.txt</NomeArquivoOrigem>
<Hash>162d3118ad4466d3f5d3fa47ee7e5b0890d25201bf7dea834670a6cde8162853</Hash>
<DataHoraTransmissao>2012-01-01T10:25:00</DataHoraTransmissao>
<DataHoraDisponibilizacao>2012-01-01T10:25:00</DataHoraDisponibilizacao>
<Observacao>Informaes complementares</Observacao>
</Arquivo>
</Resultado>

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Listagem 3: Formato XML com nvel de detalhe Completo


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Arquivo>
<Protocolo>1</Protocolo>
<TipoArquivo>XPTO</TipoArquivo>
<CodigoDocumento>1234</CodigoDocumento>
<EstadoAtual>
<DataHora>2012-01-01T10:25:00</DataHora>
<Codigo>1</Codigo>
<Descricao>Protocolo gerado</Descricao>
<CodigoDescricaoComplementar>2</CodigoDescricaoComplementar>
<DescricaoComplementar>descricao</DescricaoComplementar>
</EstadoAtual>
<SituacaoAtual>
<Codigo>3</Codigo>
<Descricao>A receber</Descricao>
</SituacaoAtual>
<Emissor>
<Unidade>99999</Unidade>
<Dependencia>0000</Dependencia>
<Operador>teste</Operador>
<NomeInstituicao>IF Teste</NomeInstituicao>
</Emissor>
<Destinatario>
<Unidade>99999</Unidade>
<Dependencia>0000</Dependencia>
<Operador>teste</Operador>
<NomeInstituicao>IF Teste</NomeInstituicao>
</Destinatario>
<Respostas>
<Protocolo>2</Protocolo>
</Respostas>
<TamanhoArquivo>10</TamanhoArquivo>
<NomeArquivoOrigem>nomeArquivo.txt</NomeArquivoOrigem>
<Hash>162d3118ad4466d3f5d3fa47ee7e5b0890d25201bf7dea834670a6cde8162853</Hash>
<DataHoraTransmissao>2012-01-01T10:25:00</DataHoraTransmissao>
<DataHoraDisponibilizacao>2012-01-01T10:25:00</DataHoraDisponibilizacao>
<Observacao>Informaes complementares</Observacao>
<Historico>
<Estado>
<DataHora>2012-01-01T10:25:00</DataHora>
<Codigo>1</Codigo>
<Descricao>Protocolo gerado</Descricao>
<CodigoDescricaoComplementar>1</CodigoDescricaoComplementar>
<DescricaoComplementar>Descrio</DescricaoComplementar>
<UnidadeResponsavel>99999</UnidadeResponsavel>
<OperadorResponsavel>teste</OperadorResponsavel>
</Estado>
</Historico>
</Arquivo>
</Resultado>

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Listagem 4: Formato XML da mensagem de erro


Listagem A21.

Exemplo do formato XML erro

<?xml version="1.0" encoding="UTF-8"?>


<Resultado>
<Erro>
<Codigo>400</Codigo>
<Descricao>Descrio do erro</Descricao>
</Erro>
</Resultado>

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

Banco Central do Brasil, 2015

Manual de utilizao dos Web Services do STA

Verso 1.1.9

Anexo 1: Fluxo de estados no envio de arquivos

40

Banco Central do Brasil, 2015

You might also like