Gerncia de Desenvolvimento

Protocolo de Comunicao

Guia de Referncia do Quotemod 2 v1.3

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 1/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

Controle de veres do documento Data 10/09/200 9 14/09/200 9 21/09/200 9 22/10/201 0 Descrio Criao do do umento Adio do$ iten$ on#en%e$ e one&o Adio de in'orma%e$ $o(re o$ ampo$ Alterao omando )ogon *n lu$o de +amada$ Ad#i$e de $er#io$ Verso 1!0 1!1 1!2 1!, tuali!ado "or "agner Al#e$ "agner Al#e$ "agner Al#e$ Claudiomar Moreira

1 # $ntroduo - .uotemod / um roteador de omando$ para o$ $er#idore$ de onte0do da Ag1n ia 2$tado! 2$$e$ $er#idore$ di$poni(ilizam uma inter'a e de omando u3o a e$$o / deito atra#/$ do .uotemod! - .uotemod tran$'orma o proto olo 4road a$t 5proprietrio da Ag1n ia 2$tado6 em um proto olo te&to $impli'i ado7 para i$$o7 po$$ui uma inter'a e nati#a de omando$ 8ue $er de$ rita no pr9&imo item! :entre a$ 'un ionalidade$ do .uotemod podemo$ de$ta ar: :i$poni(iliza uma inter'a e $imple$ para e&e utar omando$ e o(ter dado$ do $er#idor de in'orma%e$ da Ag1n ia 2$tado; Cada $e$$o de u$urio / #in ulada a uma one&o '<$i a 5$o =et6 om o .uotemod; 2&i$te apena$ uma porta de one&o om o .uotemod; - u$urio / autenti ado 3unto ao $er#idor7 no $endo po$$<#el autenti ar mai$ de uma $e$$o ao me$mo tempo para o me$mo u$urio; - .uotemod en#ia um =eep>ali#e ao u$urio7 a$o nen+uma outra re8ui$io e$te3a $endo atendida7 ontendo data/+ora do $er#idor!

2 # Convenes ?n @ ara tere de no#a lin+a! ?t @ ara tere de ta(ulao! 3 # Cone%o - endereo *P do .uotemod / pa$$ado pela Produo da Ag1n ia 2$tado e a porta de one&o / a &'&1! Aanto a$ $oli ita%e$ omo a$ re$po$ta$ do $er#idor $o tra'egada$ pela me$ma one&o!

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 2/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

( # $nterface de Comandos Aodo$ o$ omando$ $eguem o padro a(ai&o: )$D*+t)C,- .D,*+t)/0RV$C,*+t)P R -1*+t...)P R -n*+n :e$ rio: +t @ Cara tere AA4; +n @ .ue(ra de )in+a; )$D* @ B0mero de identi'i ao do liente! Cer de#ol#ido 3untamente om a re$po$ta do $er#idor; )C,- .D,* @ Comando$ nati#o$ do .uotemod! Co $uportado$ o$ $eguinte$ omando$: o CAADA @ *ni ia um ad#i$e; o CA-P @ *nterrompe um ad#i$e; o 2E2C @ 2&e uta uma 'uno no servidor de conte1do7 a$ 'un%e$ do $er#idor $ero demon$trada$ adiante; o D2. @ 2&e uta uma on$ulta a um onte0do e$tti o do $er#idor; o P-F2 @ *n$ere um dado no $er#idor; o )-G-B @ *ni ia uma $e$$o de u$urio no $er#idor; o )-G-HH @ He +a uma $e$$o de u$urio no $er#idor; o F22P @ 2#ita 8ue $e$$o $e3a 'e +ada automati amente por timeout! :e#e $er emitido periodi amente a$o nen+uma outra tran$ao $e3a $oli itada; )/0RV$C,* @ Cer#io e t9pi o a $er on$ultado! 2&!: 4CIAA*J-7 AP*IAP*7 et ! )P R -n* @ ParKmetro pertinente a $oli itao de$e3ada! 2&!: P2AD47 JA)2L7 et ! 2 # Res"ostas - $i$tema gera di'erente$ tipo$ de re$po$ta$ on'orme a on$ulta ou omando e&e utado! Res"osta "ara Comando

C+t)$D*+t)3 - .4,*+t)D D,/* -nde: C @ *ndi a 8ue $e trata de uma re$po$ta de omando +t @ Cara tere AA4 5M96 )$D* 5 B0mero de identi'i ao do liente! Hoi en#iado 3untamente om a re8ui$io )3 - .4,* 5 Aaman+o 5em (Nte$6 do onte0do retornado pelo $er#idor )D D,/* 5 :ado$ retornado$ pelo $er#idor 5arraN de (Nte$6!

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: ,/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

Res"ostas de 0rro

0+t)$D*+t)3 - .4,*+t)-ensa6em de erro* -nde: 0 @ *ndi a 8ue $e trata de uma men$agem de erro +t @ Cara tere AA4 5M96 )$D* @ B0mero de identi'i ao do liente! Hoi en#iado 3untamente om a re8ui$io )3 - .4,* @ Aaman+o 5em (Nte$6 do onte0do retornado pelo $er#idor )-ensa6em de erro* @ Men$agem de erro en#iado pelo $er#idor!

dvises Ad#i$e$ $o noti'i a%e$ automti a$ de alterao de um determinado item! Atra#/$ de$$e me ani$mo7 um u$urio pode $er a#i$ado $o(re altera%e$ no #alor de um papel7 atualizao de +ora no $er#idor7 a#i$o$ de mudana na$ permi$$%e$ do u$urio7 et ! Para omear a re e(er e$$a$ noti'i a%e$ para um item7 o me$mo de#e $er a$$inado atra#/$ do omando CAADA! Ad#i$e$ $o en#iado$ pelo .uotemod om a $eguinte e$trutura:

+t)/0RV$C,73,P$C,*+t)$30-*+t)3 - .4,*+t)D D,/* -nde: @ / o *: 8ue indi a 8ue $e trata de um ad#i$e; +t @ Cara tere AA4 5M96; )/0RV$C,73,P$C,* @ Cer#io e t9pi o 8ue gerou a noti'i ao! 2&!: 4CIAA*J-7 AP*IAP*7 et !; )$30-* @ *tem noti'i ado! 2&!: P2AD47 JA)2L7 MABCO2A2C et ! )3 - .4,* @ Aaman+o 5em (Nte$6 do onte0do retornado pelo $er#idor )D D,/* @ :ado$ retornado$ pelo $er#idor 2&emplo: Comando: *d?tCAADA?t4CIAA*J-?tpetr4 De$po$ta on$ulta: C?tid?t,?t-F?0 De$po$ta ad#i$e: A?t4CIAA*J-?tP2AD4?t,00 ?tP2AD4?t ,,!0L?t 17:07?t!!!?0

- on3unto C2DJ*C-IA-P*C- e *A2M / 0ni o dentro do $i$tema! Bo e&emplo a ima7 o liente de#e $a(er 8ue em um momento 'oi $oli itada a in'ormao $o(re o $er#io P4CIAA*J-Q om o parKmetro PP2AD4Q!

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 4/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

8 # Comandos Para a e&empli'i ao do$ omando$ u$aremo$ 1 omo *:! ,9servao: Para on$ulta$ 8ue retornam $u e$$o ou no $u e$$o $er adotado omo padro de re$po$ta: P-FQ @ $u e$$o e PB-FQ @ para no $u e$$o7 no ampo Rdado$S7 lem(rando e$te ampo / um arraN de (Nte$ e portando para $tring$ o ara tere ?0 $er on$iderado! Algun$ omando$ onde $o pa$$ado$ mai$ de um parKmetro a re$po$ta negati#a poder $er $eguida do$ parKmetro$ negado$7 $eparado$ por AA45?t6! Para e&emplo$ #e3a a ta(ela 2! - 'ormato do$ dado$ retornado em Rdado$S pode #ariar on'orme o omando $oli itado! 3a9ela 1 5 0%em"los de comandos ; res"osta Comando $d+tlo6on+tuser+t"s<+n

Res"ostas C?tid?t,?t-F?0 ou $e o orrer erro 2?tidt?2T?tU$urio$ e/ou $en+a in#lido$?0 -($! - taman+o / ,7 poi$ o arraN de (Nte$ ont/m o ara tere ?0! C?tid?t,?t-F?0 C?tid?tT?tB-F?tppp?0 C?tid?t4?tB-F?0 C?tid?t4?tB-FY:ata in#alida! ?0 R:A:-CSY B-FY:ata in#alida! ?0

$d+t/tart+t=C7 3$V,+t>+n $d+t/3 R3+t=C7 3$V,+t"etr(+t """+n $d+tR0Q+t t=C7 3$V, +tsss+n $d+t0;0C+t P$7 P$+tPegaBoti ia$54D-A:CACA7 A2>BeV$7 W7 2X0X096+n

8.1 # Comando ?,G,. Haz o logon de um u$urio pre#iamente ada$trado no $i$tema! /inta%e Comando: id?t)ogon?tu$urio?t$en+aZ?tRli$ta de parKmetro$S[?n Par@metros do comando U$urio @ Bome do u$urio 8ue $er autenti ado Cen+a @ Cen+a do u$urio a $er autenti ado li$ta de parKmetro$ 5opcional6: li$ta de parKmetro$ para a $e$$o no 'ormato<chave>=valor;...;<chave_N>=<valor_N> -$ parKmetro$ atualmente re on+e ido$ $o: Co'tVare: id do $o'tVare na 4CAA 5e&: 2A para \ 0 -,V0? =R,B0R\6! Ce no 'or de larado7 $er a$$umido o #alor de'ault on'igurado no $er#idor A2:ataHeed )anguage: id do idioma a $er utilizado na$ re$po$ta$ de erro! :e'ault Y \"t\ U$erGroup: grupo a 8ue perten e o u$urio! :e'ault Y \1\ 5grupo \A2\ > atualmente no e&i$tem outro$ grupo$ de'inido$6

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: L/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao
Ao=en:i$ onne t: to=en de $e$$o da 4CAA a $er de$ one tada7 a$o ne e$$rio 5#er o($er#ao a(ai&o6

Res"osta Cu e$$o: C?tR*dS?tRAaman+oS?tRCtatu$S 2rro: 2?tR*dS?tRAaman+oS?tR2rroS 0%em"lo de "licao Comando: 1?t)ogon?tu$urio?t$en+a?n De$po$ta: C?t1?t,?t-F?0 ou 2?t*dt?2T?tU$urio$ e/ou $en+a in#lido$

-($: 2m a$o de erro7 o apli ati#o pode #eri'i ar $e o moti#o 'oi a pre$ena de $e$$%e$ 4CAA para o me$mo login em outra$ plata'orma$7 e7 ne$$e a$o7 mo$trar uma li$ta de$$a$ $e$$%e$ para 8ue o u$urio e$ ol+a 8ual dela$ de#e $er de$ one tada! Uma #ez e$ ol+ida uma $e$$o7 de#e $er tentado no#o )ogon pa$$ando o id da $e$$o a de$ one tar #ia parKmetro 3oCenDisconnect! Ca$o +a3a $e$$%e$ a de$ one tar7 o ampo R2rroS ter o $eguinte 'ormato: o ,"en/essions?t)lista de sesses* onde )lista de sesses* / a li$ta de $e$$%e$ atualmente ati#a$ para o login7 no 'ormato )toCen*;)"lataforma*;)data*?n!!!

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: X/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

8.2 # Comando ?,G,DD Aermina a $e$$o e de$ one ta o u$urio! /inta%e id?t)ogo''?n Par@metros do comando Bo $e apli am Res"osta C?t*d?tAaman+o?tCtatu$ 0%em"lo de "licao Comando: 1?t)ogo''??n De$po$ta: C?t1?t,?t-F?0 8.3 # Comando B00P Feep ali#e do $o =et! :e#er $er en#iada apena$ a$o nen+um outro omando $e3a en#iado num determinado per<odo! /inta%e id?tF22P?n Par@metros do comando Bo $e apli am! Res"osta Bo $e apli a 0%em"lo de a"licao 1?tF22P?n

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 7/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

8.( # Comando 0;0C - omando 2E2C do .uotemod e&e uta 'un%e$ do$ $er#idore$ de onte0do! 2$$a$ 'un%e$ $o a e$$<#ei$ $omente atra#/$ do omando 2E2C! /inta%e id?t0;0C?t/0RV$C,73,P$C,?tDE.FG,HP R1I P RnJ?n Par@metros do comando Bo $e apli am! Res"osta do comando :e$ rito na ta(ela de 'un%e$! 0%em"lo de a"licao A ta(ela a(ai&o mo$tra alguma$ 'un%e$ mai$ omumente u$ada$!
Duno Par@metros usuario: login do u$urio senKa: Z$en+a[ ou ]^ Z+a$+ multi ript[ do u$urio7 para autenti ao soft<are: id do $o'tVare7 de a ordo om a ta(ela *denti'i adore$ da 4CAA 6ru"o 5op ional6: grupo a 8ue perten e o u$urio > $e #azio7 $er a$$umido de'ault do $er#idor idioma 5op ional6: idioma em 8ue a 4CAA de#e en#iar men$agem de erro > $e #azio7 $er a$$umido de'ault do $er#idor toCenLdesconecta 5op ional6: to=en de $e$$o da 4CAA 8ue de#e $er de$ one tada para atender e$te pedido de logon Bo $e apli am Descrio A(re uma $e$$o de u$urio! - u$urio pode perten er _ (a$e lo al ou _ 4CAA! 2$te m/todo pode $er utilizado para a(rir uma $e$$o e retornar a li$ta de $er#io$ permi$$ionado$ / re$pon$#el para o pelo u$urio! - apli ati#o liente 2rro 5dependendo da 'onte da men$agem6: .,BMRMen$agem de erroS ou .,BMR 9digo de erroS?tRmen$agem de erroS 0%em"lo de a"licao Comando: 1?t2E2C?tA2UC2DI P2DM?-penU$erCe$$ion5u$uario7$en+a7$o'tVare7idi omaY\pt\7to=en`de$ one taY\\6?n De$po$ta: Cu e$$o: ,BM<produto>=<servio>\n...\n<servio_N>\r ...\r<produto_N>=<servio>\n...\n<servio_N>

-penU$erCe$$ion

tratamento da$ permi$$%e$ retornada$!

Detorna toda$ a$ data$ de noti ia$ $er#idor! di$pon<#ei$ no

Um $9 omando: Comando: id?t2E2C?tAP*IAP*?tPega:ata$56?n De$po$ta: C?tid?t(Nte$?t-FY::MMAA?t::MMAA

Pega:ata$

PegaCer#i o$Cate goria$

Produto @ 4D-A:CACA Cer#io @ nome do $er#io! Pode $er u$ado

Detorna todo$ o$ permi$$ionado$ u$urio 56!

aderno$ para o

Comando: De$po$ta:

1?t2E2C?tAP*I C?t1?t2LLL?t-FY

AP*?tPegaCer#i o$Categoria$54D-A:CACA7W6 ?n

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: T/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao
o W para todo$! Produto @4D-A:CACA Caderno @ re$ultado da 'uno anterior! PegaBoti ia$ Categoria todo$! :ata @ :ata7 no 'ormato ::MMAA! @ W para W$er#i o$A2?nWPtrYpar! Co3a Gro?t!!!?n Comando: 1?t2E2C?tAP*I AP*?tP2GAB-A*C*AC54D-A:CACA7 040L096?n De$po$ta: C?t1?t2,T47?t-FY040L09;A2>BeV$;A2> BeV$;B00T4090L04;IAo #i#o: al#aro 4andeira7 :a agora7 Hala!!! A2>BeV$7 W7

Detorna toda$ a$ noti ia$ de um aderno

Duno

Par@metros *: @ *denti'i ador 0ni o da noti ia7 re e(ido na 'uno Ppeganoti ia$Q!

Descrio Detorna o onte0do de uma noti ia

Comando: De$po$ta:

0%em"lo de a"licao 1?t2E2C?tAP*I C?t1?t22L4?tROAM)SR4-:b olorY(la = 14:22 G>7: c

AP*?tColi itaAe&to5B00T4090L046?n (g olorYV+iteS?nRH-BA 'a eYarialSRddSR(S R/OAM)S orpo?tConte0do

Coli itaAe&to

U$urio @ U$ername! Produto @ P4-)CACQ7 e e pagina$ P4-)CAC`:*H2D*:-Q P4-)CAC`CBAPCO-AQ para GetPermU$er para 'i&a$! Pagina @ PCQ para ati#o$ e P"Q para not< ia$ e pagina$ 'i&a$! ati#o$ noti ia$ e

Detorna a$ permi$$%e$ de um u$urio

Comando: 1?t2E2C?tA2UC2DIP2DM?tGetPermU$er GetPermU$er52du7 4-)CAC`:*H2D*:-7 C6 ?n De$po$ta: C?t1?tX?tBbC2?t?0

P4D-A:CACAQ

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 9/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

8.2 # Comando R0Q - omando D2. 'az a re8ui$io de ta(ela$ e dado$ de ati#o$ li(erado$ para o u$urio! omando D2. permite a re8ui$io de 8ual8uer item 'orne ido pelo $er#idor7 ma$ a t<tulo de e&emplo #amo$ no$ on entrar na re8ui$io de ta(ela$ e ati#o$7 8ue $o o$ mai$ utilizado$! ReNuisio de 3a9elas A$ ta(ela$ mai$ utilizada$ $o a$ de (ol$a$ e ati#o$! A primeira ont/m o$ dado$ da$ (ol$a$ li(erada$ para o u$urio7 a $egunda ont/m o$ ati#o$! A re8ui$io de ta(ela$ pode $er 'eita dentro do $er#io 4CIAA42)A! 0%em"lo 1: ReNuisio da ta9ela de 9olsas Comando: 1?tD2.?t4CIAA42)A?t4-)CAC?n - retorno da in'ormao $egue o 'ormato: C?tid?t?(Nte$?t RB-M2 :A 4-)CAS?tRCd:*G- :A 4-)CAS?nRB-M2 :A 4-)CAS?tRCd:*G:A 4-)CAS?n!!! RB-M2 :A 4-)CAS > / o nome por e&ten$o da (ol$a RCd:*G- :A 4-)CAS > / o 9digo 8ue e$tar atrelado a um ati#o!

Para o omando apre$entado anteriormente a re$po$ta $eria: C?t?1?t22T?t4MH?t002?tA2>AAEAC?t!!! 0%em"lo 2: ReNuisio de ta9elas de ativos A ta(ela de ati#o$ ont/m o$ dado$ do$ ati#o$ e o$ rela ionam om a$ (ol$a$ e O2A:2DC! Comando$: 1?tD2.?t4CIAA42)A?tAA42)A?n 1?tD2.?t4CIAA42)A?tAA42)A`:*H2D*:-?n 1?tD2.?t4CIAA42)A?tAA42)A`CBAPCO-A?n - retorno da in'ormao $egue o 'ormato: C?tid?t?(Nte$?tRCd:*G- :A 4-)CAS;RO2A:2DS;RCd:*G- :- AA*J-S;RCG2BeD*C-S?t!!! RCd:*G- :A 4-)CAS > / o 9digo da (ol$a a 8ual (ol$a o ati#o perten e7
Pgina: 10/19 Atualizado por: Claudiomar Moreira

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Gerncia de Desenvolvimento
Protocolo de Comunicao
RO2A:2DS > pode ter o$ #alore$ M para Mer adoria$7 A para A%e$ e A para Aa&a$ RCd:*G- :- AA*J-S > C9digo do ati#o por e&emplo P2AD4 RCd:*G G2BeD*C-S > - 9digo gen/ri o do ati#o no / o(rigat9rio7 ma$ repre$enta um alia$ para o ati#o original! Para o omando apre$entado anteriormente a re$po$ta $eria: C?t1?11XT1T?t0002;M;:-)E09C2700?tc ReNuisio de tivos

A re8ui$io de ati#o$ $oli ita ao $er#idor o$ dado$ mai$ atuai$ de determinado ati#o! A re8ui$io de ati#o$ pode $er 'eita dentro do$ $er#io$ 4CIAA*J- 5tempo real67 4CIAA*J-`:*H2D*:- e 4CIAA*J-`CBAPCO-A! 0%em"lo 1: ReNuisitando os cam"os do ativo -$ ampo$ do ati#o #ariam on'orme o +eader ao 8ual ele e$te3a ada$trado 5AC-2C7 M2DCC ou AAEAC6! Comando: id?tD2.?t4CIAA*J-?tAC-2C?n De$po$ta: C?t1?t222?tAti#o?tU)A?tO-D?t!!! 0%em"lo 2: ReNuisitando valores dos cam"os e importante notar 8ue o$ #alore$ #1m na me$ma po$io de onde #ieram o$ nome$ do$ ampo$! Comando: id?tD2.?t4CIAA*J-?tP2AD4?n De$po$ta: C?t1?tL47?tP2AD4?t,27,,?t1X:40?t!!!
Etili!ando o 40 D0R como 6a9arito "ara os valores - O2A:2D de#e $er utilizado omo ga(arito para o$ #alore$ do$ ati#o$ a ta(ela a(ai&o ilu$tra omo o O2A:2D indi a o po$i ionamento do$ #alore$! 2$$a ta(ela / e&atamente o re$ultado do$ omando$ anteriormente itado$!

coes
3$V, P2AD4 E?3 ,47X7 4,R 1T:1, V R 070X - ; ,477T -$. ,4711 D0C ,47XL =0 ,47,T ,CP ,47XX ,VD ,47X7 .0G 1L90T QE? 900 -0D ,4747 V,C L400 V,V TT00

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 11/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao
-$ ampo$ de ada O2A:2D7 (em omo $ua$ de$ ri%e$ e$to no Ap1ndi e 1!

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 12/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

8.8 # Comando /3 R3 - omando CAADA $oli ita ao $er#idor 8ue ini ie o en#io de men$agen$ 5ad#i$e$6 a ada atualizao do item 8ue 'oi $oli itado! 2$$e omando pode $er u$ado em di#er$a$ $itua%e$! Colo amo$ a8ui algun$ u$o$ ($i o$ de$$e omando! A(ordamo$ a parte de not< ia$7 ati#o$ e alerta$ de alterao de ta(ela$! A ta(ela a(ai&o mo$tra o$ e&emplo$ de u$o do CAADA!

Etili!ao do comando /3 R3 0strutura do comando: )$D*+t/3 R3+t)/0RV$C,*+t)P R -1*+t...)P R -n*+n Res"ostas: De$po$ta de omando e de Ad#i$e$ /ervio Par@metros Descrio AP*IAP* MABCO2A2C ltima$ man +ete$ re e(ida$ pelo $er#idor

0%em"lo de a"licao Comando: 1?tCAADA?tAP*IAP*?tMan +ete$?n De$po$ta: C?t?1?t,?t-F A?tCer#io?t*tem?tAaman+o?t:ado$ 2&emplo: A?tAP*I AP*?tMan +ete$?t111?t040L09?tfB/2nergN?t!!?n Comando: 1?tCAADA?tA2UC2DIA)A2DA?tA)A2DA?n De$po$ta: C?t1?t,?t-F?0 5$u e$$o6 ou C?t1?t4?tB-F?0 5$em $u e$$o6! A?tCer#io?t*tem?tAaman+o?t:ado$ 2&emplo: A?tA2UC2DIA)A2DA?tA)A2DA?t111?t !!!?n Comando: 1?tCAADA?t4CIAA*J-?tPetr4?n De$po$ta: C?t1?t,?t-F A?tCer#io?t*tem?tAaman+o?t:ado$ 2&emplo: A?t4CIAA*J-?tP2AD4?t,0L?tP2AD4?t,1!27?t!!!?n Comando: id?tCAADA?t4CIAA*J-?tW?n De$po$ta: C?tid?t(Nte$?tCtatu$ A$ re$po$ta$ de Ad#i$e $ero en#iada$ a medida 8ue o$ ati#o$ ti#erem $eu$ #alore$ atualizado$7 $endo uma para ada ati#o!

A2UC2DI A)A2DA

A)A2DA

*ndi a 8ue +ou#e uma mudana na ta(ela de ati#o$; adio7 remoo7 alterao7 et ! Bo dei&e de #er o($er#ao ao 'inal de$$a $e$$o! *ni ia o en#io de in'orma%e$ de um ati#o!

4CIAA*J-7 4CI AA*J-`:*H 2D*:- ou 4CI AA*J-`CB APCO-A

C9digo do Ati#o7 por e&emplo P2AD4 W o a$teri$ o $igni'i a todo$

*ni ia o en#io de in'orma%e$ de todo$ o$ ati#o$ li(erado$ para o u$urio! - en#io da$ in'orma%e$ / 'eito $omente 8uando + atualizao de algum #alor do ati#o! Para o(ter a 0ltima po$io7 de#e $e utilizar o D2.! *ni ia o en#io de in'orma%e$ do$ ati#o$ 8ue e$te3am na li$ta!

)i$ta de 9digo$ de ati#o$!

Comando: id?tCAADA?t4CIAA*J-?tP2AD4?tJA)2L?n De$po$ta: C?tid?t(Nte$?tCtatu$ A$ re$po$ta$ de Ad#i$e $ero en#iada$ a medida 8ue o$ ati#o$ ti#erem $eu$ #alore$ atualizado$7 $endo uma para ada ati#o!

/ervio

Par@metros

Descrio

0%em"lo de a"licao

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 1,/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao
4CI)*JDC9digo do Ati#o!-CP ou C9digo do Ati#o!-J: *ni ia o en#io de in'orma%e$ de li#ro de o'erta$! Comando: 1?tCAADA?t4CIAA*J-?tPetr4!-J:?n De$po$ta: C?t1?t,?t-F A?tCer#io?t*tem?tAaman+o?t:ado$ 2&emplo: A?t4CI)*JD-?tP2AD4!-J:?t274?tA?t,1!29?t!!!

,9servao: -onitorar alterao de "ermisses

0E/0R7 ?30R

Para monitorar altera%e$ de permi$$%e$ de#e>$e utilizar o omando CAADA om o $er#io A2UC2DIA)A2DA e parKmetro A)2ADA! 2&emplo: *d?tCAADA?tA2UC2DIA)A2DA?tA)A2DA?n A re$po$ta $er no 'ormato ad#i$e $endo 8ue o ampo R:A:-CS ter o $eguinte 'ormato: R:A:-CS Y 3i"o+tE/0R onde : 3i"o > Aipo de mudana no permi$$ionamento7 podendo $er : P.Q > Hoi ada$trado ou de$ ada$trado algum produto7 $er#io ou ategoria 5para e$te u$urio ou para todo$6! .uando o orrer e$te re e(imento7 o di$plaN de#e re$$oli itar toda$ a$ in'orma%e$ re'erente$ ao t9pi o AP* 5produto$7$er#io$ e ategoria$6! P Q > Alguma in'ormao re'erente ao$ ati#o$ 'oi alterada! Be$te a$o o di$plaN de#e re$$oli itar a ta(ela de ati#o$7 poi$ no e$t mai$ #lida! :e po$$e de$ta no#a ta(ela7 ele pode $a(er 8uai$ ati#o$ no e$to mai$ permi$$ionado$7 ou o$ no#o$ ati#o$ di$pon<#ei$! .ual8uer $oli itao de algum ati#o 8ue ten+a perdido permi$$ionamento retornar B/A! PRQ > *dem para pgina$ em Deal Aime! :e#e $er pedida a li$ta de pgina$ di$pon<#ei$ no#amente! Alguma$ pgina$ em ad#i$e podem no $er mai$ #lida$! PGQ > - orreram mudana$ em doi$ ou mai$ do$ <ten$ anteriore$! Aoda$ a$ in'orma%e$ ontida$ no di$plaN de#em $er re$$oli itada$! E/0R > U$urio a'etado! .uando a$ altera%e$ a'etam a todo$ o$ u$urio$ 5Cada$tramento de um no#o ati#o67 e$te ampo #ai preen +ido om o #alor Pge#erN(odNgQ!

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 14/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao
8.A # Comando /3,P Para ada item 8ue o liente 'az o CAADA7 de#e $er 'eito um CA-P 8uando a in'ormao no 'or mai$ de$e3ada! A ta(ela a(ai&o mo$tra o u$o do CA-P!

Etili!ao do comando /3,P 0strutura do comando: )$D*+t/3,P+t)/0RV$C,*+t)P R -1*+t...)P R -n*+n Res"ostas: De$po$ta de omando Cer#io ParKmetro AP*IAP* MABCO2A2C A2UC2DI A)A2DA A)A2DA

:e$ rio *nterrompe o en#io da$ man +ete$! *nterrompe o en#io de in'orma%e$ de altera%e$ de ta(ela$ de ati#o$ *nterrompe o en#io de in'orma%e$ do ati#o! *nterrompe o en#io de in'orma%e$ de todo$ ati#o$! *nterrompe o en#io do$ ati#o$ 8ue e$te3am na li$ta! *nterrompe o en#io de in'orma%e$ de li#ro de o'erta!

2&emplo de apli ao Comando: 1?tCA-P?tAP*IAP*?tMan +ete$?n De$po$ta: C?t?1?t,?t-F Comando: 1?tCA-P?tA2UC2DIA)A2DA?tA)A2DA?n De$po$ta: C?t1?t,?t-F?0 5$u e$$o6 ou C?t1?t4?tB-F?0 5$em $u e$$o6! Comando: 1?tCA-P?t4CIAA*J-?tPetr4?n De$po$ta: C?t1?t,?t-F Comando: 1?tCA-P?t4CIAA*J-?tW?n De$po$ta: C?t1?t,?t-F Comando: 1?tCA-P?t4CIAA*J-?tP2AD4?tJA)2L?n De$po$ta: C?t1?t,?t-F Comando: 1?tCA-P?t4CIAA*J-?tPetr4!-J:?n De$po$ta: C?t1?t,?t-F?0 Comando: 1?tCA-P?t4CIAA*J-?tPetr4!-CP?n De$po$ta: C?t1?t,?t-F?0

4CIAA*J-7 4CI AA*J-`:*H2D *:- ou 4CI AA*J-`CBAPC O-A 4CI)*JD-

C9digo do ati#o W o a$teri$ o $igni'i a todo$ )i$ta de ati#o$

C9digo do Ati#o!-CP ou C9digo do Ati#o!-J:

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 1L/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

A#

dvise

7.1 - @SERVICE_ACTIVE@ Vlido para todos os servios (ex. AEUSER|PERM, BC|ATIV , et!." Descrio: O item "@SERVICE_ACTIVE@" pode ser assinado (comando START, para recebimento de advises) ou consultado (comando REQ) para qualquer servio acessvel via servidor AEDataFeed, e permite aos aplicativos clientes identificarem o estado de disponibilidade (ativo/inativo) de um servio . Formato

!"a#_ati$o%!t &'d("o%!t descrio% onde

!"a#_ati$o% 1 (servio ativado) ou ) (servio desativado) &'d("o% nome do m"dulo que gerou o evento de ativa#o/desativa#o ($) descrio% descri#o do motivo causador do evento de ativa#o/desativa#o ($)

($) %ampos opcionais, podem n#o e&istir dependendo da fonte geradora do evento

7.* - DISC+,,ECT-SER A'()'*+,'*Descrio: Advise para notificar aplicativos clientes sobre descone&#o de usu.rios. O aplicativo cliente deve remover das suas estruturas de sess#o o usu.rio desconectado e/ou alterar o estado do usu.rio para desconectado. /#o 0 necess.rio c1amar C"ose-serSessio. em resposta a este advise. Formato

&oti$o%!t (s(/rio% onde

&oti$o% qual tipo de evento causou a descone&#o. 2alores con1ecidos 1o3e (novos valores poder#o ser adicionados no futuro) o 0+1+FF sess#o fec1ada normalmente
o o o

TI2E+-T sess#o fec1ada por timeout DESC+,ECTA sess#o desconectada pelo administrador ou pela 4%AA DESCADASTRA usu.rio foi descadastrado

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 1X/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

(s(/rio% login do usu.rio cu3a sess#o foi desconectada

7.3 - 4ER2-SER A'()'*+,'*Descrio: Advise para notificar aplicativos clientes sobre repermissionamento de usu.rios na 4%AA. O aplicativo cliente, em momento oportuno, deve solicitar as permiss5es necess.rias (por e&emplo, invocando novamente o m0todo Open(ser)ession para usu.rios abertos atrav0s desse mecanismo). Formato

(s(/rio% onde

(s(/rio% login do usu.rio cu3as permiss5es foram alteradas

Obs

/ovos campos, al0m de (s(/rio%, podem ser adicionados a este item no futuro com separador 5t (6A4), portanto o parser do aplicativo cliente deve estar preparado para ignorar campos descon1ecidos

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 17/19 Atualizado por: Claudiomar Moreira

Gerncia de Desenvolvimento
Protocolo de Comunicao

"ndice 1 # Cam"os de

tivos

Ati#o$ $o o$ pap/i$ nego iado$ em (ol$a7 u3o$ #alore$ 5 ota%e$6 $o di#ulgado$ em Aempo Deal pela 4roadCa$t e mo$trado$ de #ria$ maneira$ pelo A2 4road a$t! Cada ati#o tem um 9digo7 um Bome Completo e $eu$ #alore$ de ota%e$! Por e&emplo7 a$ a%e$ da ompan+ia Petro(ra$ nego iado$ na 4ol$a de Co Paulo $o di#ulgada$ omo ati#o om o 9digo P2AD4 e o nome ompleto P2AD-4DAC PB! -$ ati#o$ $o di#idido$ em , ategoria$ a$ 8uai$ +amamo$ de O2A:2DC: A%e$7 Mer adoria$ e Aa&a$! A ta(ela a(ai&o mo$tra o$ ampo$ de ada O2A:2D (em omo $ua de$ rio!

es A42 AB1 AB2 AB, AB4 AA*JCCP CJ: :CD :HC :H2 :DH :UA :JC 2CA HC2 H2C O-1 O-2 O-, O-4 O-D *BC MAE M2: M*B BCC BCJ B2G B-M BC. -CP -J: P2E PP* PDD PAD

-ercs A42 AB1 AB2 AB, AB4 AA*JCCP CJ: :CD :HC :DH :UA :JC 2CA H2C O-1 O-2 O-, O-4 O-D MAE M2: M*B BCC BCJ B2G B-M BC. -CP -J: P2E PDD

3a%as A42 AB1 AB2 AB, AB4 AA*J-

Descrio a(ertura Aime$hArade$ 54 0ltimo$ neg9 io$6 Aime$hArade$ 54 0ltimo$ neg9 io$6 Aime$hArade$ 54 0ltimo$ neg9 io$6 Aime$hArade$ 54 0ltimo$ neg9 io$6 9digo do ati#o C9digo da orretora de ompra C9digo da orretora de #enda :ia$ orrido$ at/ o #en imento :ata do 0ltimo 'e +amento :ata do 'e +amento do prego eletrini o :ata de re'er1n ia :ia$ 0tei$ at/ o #en imento :ata de #en imento 2$tado He +amento do prego eletrini o 'e +amento Aime$hArade$ 5Oorrio do$ 0ltimo neg9 io$6 Aime$hArade$ 5Oorrio do$ 0ltimo neg9 io$6 Aime$hArade$ 5Oorrio do$ 0ltimo neg9 io$6 Aime$hArade$ 5Oorrio do$ 0ltimo neg9 io$6 +ora da 0ltima otao *nde&ador de orreo m&ima m/dia m<nima C9digo da orretora ompradora C9digo da orretora #endedora n0mero de neg9 io$ Bome do ati#o B0mero de $a8ue$ o'erta de ompra o'erta de #enda Preo de e&er < io Parti ipao per entual no *4-J Preo de re'er1n ia Preo te9ri o
Pgina: 1T/19 Atualizado por: Claudiomar Moreira

:CD :HC :DH :UA

H2C O-1 O-2 O-, O-4 O-D MAE M*B

B-M -CP -J: P2E

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Gerncia de Desenvolvimento
Protocolo de Comunicao
.CC .CJ .AD .AA .U) AAJ A)B AB: ABG U)A JAD J-1 J-2 J-, J-4 J-C J-D J-J .CC .CJ .uantidade da o'erta da orretora de ompra .uantidade da o'erta da orretora de #enda .uantidade te9ri a 8uantidade total 8uantidade do 0ltimo neg9 io tipo de ati#o Aaman+o do lote de nego iao tend1n ia Aipo do neg9 io preo da 0ltima otao #ariao Aime$hArade$ 5Jolume do$ 0ltimo$ neg9 io$6 Aime$hArade$ 5Jolume do$ 0ltimo$ neg9 io$6 Aime$hArade$ 5Jolume do$ 0ltimo$ neg9 io$6 Aime$hArade$ 5Jolume do$ 0ltimo$ neg9 io$6 #olume da o'erta de ompra Jolume em Deai$ #olume da o'erta de #enda A3u$te anterior a3u$te ontrato$ em a(erto ontrato$ nego iado$ 2$tado de nego iao do in$trumento +orrio da o'erta de ompra +orrio da o'erta de #enda )imite M9#el M&imo )imite M9#el M<nimo -$ ilao m&ima -$ ilao m<nima De'er1n ia do )imite M9#el bield

AAJ AB: ABG U)A JAD J-1 J-2 J-, J-4 J-C J-D J-J AfA AfU CA4 CBG 2B* O-C O-J )MA )M* -CA -C* D)M b):

AAJ AB: ABG U)A JAD J-1 J-2 J-, J-4

O-C O-J

b):

Criado por: Wagner Alves ltima Atualizao: 14/10/2011 17:27

Pgina: 19/19 Atualizado por: Claudiomar Moreira