“ Plano ESPECIFICACAO TECNICA APIs de Integragdes do Plano Utilizando o padrao Json Responsavel: Pedro Negreiros Data da atualizagao: 16/02/2023 Classificagao: Publico4 Plano wwwallstrategy.com.br SUMARIO 1. oBjeTIVo 3 2. PROCESSO DE UTILIZAGAO 3 3. AUTENTICAGAO. 3 3.1. SOLICITANDO 0 USUARIO PARA INTEGRACAO... 3 3.2 GERAGAO DE TOKEN 3 3.3. CHAVE DE IDENTIFICAGAO. 4 3.4 MENSAGENS DE RETORNO: 6 4 INTEGRACOES.... 6 41 DRE... 6 4.2. FLUXO DE CAIKA 7 43 CONTRATOS 8 4.4 INVESTIMENTOS......sn:ssmnnsenennsnen . seinen 45 BALANGO... 8 46 VENDAS.... a 4.7 INDICADORES.. 12 4.7.1 MENSAL 12 47.2, ANUAL. 1B 48 — RECURSOS HUMANOS.......cmnnnnnnnnnnnnnsnn vo 14 4.8.1 MENSALISTA voc 14 48.2 HORISTA...nccnnnnnnnnnnnsnns sons . . 15 5. MENSAGENS PADROES DE RETORNO. 16 6. ACOMPANHAMENTO NA CENTRAL DE PROCESSOS. 7 Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 22544 Plano eomclnantusmnis 1. OBJETIVO © objetivo deste documento € detalhar o funcionamento do servico API para integracdo de realizados de aplicagdes externa com o Sistema Plano. 2. PROCESSO DE UTILIZACAO Com a disponibilizag3o do servico API de integrac3o 0 usuario poderd realizar a incluso de realizados através do seu préprio ERP, fluxo do processo: CUIENTE ‘SERVIDORES D0 PLANO -. Raa utncapo— AP-PLANO supine p= sh com ekan de tet = =| a ‘2+ meaaa a nsgragd vie Jon ia 13) ~ {| toa sistema etoena com Ten par prorimes reaiigdes~ a) LANO inset uy Resins #mtegragi i non pg 31) -Cam Takes = = AM | sce brane oe rar feomitency 3. AUTENTICAGAO Seré necessario realizar a autenticacgo para integracao de realizados. 3.1 SOLICITANDO 0 USUARIO PARA INTEGRAGAO Solicitar via PSA (Portal de Suporte AllsStrategy), a liberaco de um usuario exclusivo para a utilizag3o na API de integracdo, para essa solucdo ser utilizado 0 mesmo usuério do Integrador. 3.2 GERAGAO DETOKEN Endereco da API para geracao do token: Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 22544 Plano wwwallstrategy.com.br 33 Parametros de envio: om Descrg oo co Losin Esra referent a login go usu Texto ve interadorns [LrasswoRo [senha reerenteaotogn do wsuiee. | Texto we [ese Os parametros devem ser passados via “GET” ou “POST” da seguinte maneira: 1IgR@ Parametros de retorno: co a Formato ro satus Vale verdaeir (1) 0 fo (0, ‘ansagens referents ao Satus da xecuqio er [amos [Token de avtenteagio erode pew ap Texoae [ conforms o seme deretore © token tem o prazo de expiraco de 30 segundos a partir do momento de sua criagio, apés esse tempo deve ser gerado um novo token. Exemplo: 4 “auth token’ “ey RCI6MATQytgs KUN QUIN ola WSOZWdyYWAvedxODRAYWsCSRYYAAIZSHAN29¢LmyhwiQVVUSTOUTORFTHSIO 21)ScrinoUEerMn-Um HUM NAPTUCyeGhNe LSet jen7 SUAS BEVZVGIWTRZQUSTZI RVCRBZYANVEXPWONQOMNEHy atTeMHWOD}neTON "msl: "Dacos validados com sucesso", spats) , CHAVE DE IDENTIFICAGAO Serd necessario gerar a chave de identificacao. © endereco API para gerar a chave de identificagao e passar parametros é determinado por médulo, segue o link da URL para cada médulo: © DRE. https://api-plano.allstrategy.com. br/realizado/v2/dre © Balango. hitps://api-plano.allstrategy.com,br/realizado/v2/balanco = Fluxo de caixa, hitps://api-plano.allstrategy.com,br/realizado/v2/fluxodecaixa ‘= Recursos humanos mensalista. -https://api-plano allstrategy.com.br/realizado/v2/th_mensalista Recursos humanos horista. https://api-plano.allstrategy.com,br/realizado/v2/th horista Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 22544 Plano wwwallstrategy.com.br Contratos. hitps://api-planoallstr ui nt Investimentos. https://api-plano.allstrategy.com.br/realizado/v2/investimentos * Vendas. https://api-plano.allstrategy.com,br/realizado/v2/vendas + Indicadores. https://api-plano.allstrategy.com,br/real cai Os parametros deverdo ser passados somente via "POST". Parametros de envi om Descrigte Formate co [AUTH.TOKEN Token vid gerade nd autenticago, Texto te Sy JRCINIMS NR. PAGINA. meres de paginas Numero lwe 2 ‘COMPETENCIA Para gerar o cédigo da chave de identificacao so utilizados os mesmos pardmetros de envio e retorno para os médulos: DRE, recursos humanos mensalista, recursos humanos horista, vendas, investimentos, contratos e balanco. Para o médulo de Fluxo de Caixa devido ao sistema nao permitir carga adicional deve ser passado o parmetro carga adicional como 0. Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 22544 Plano wwwallstrategy.com.br 34 ‘A chamada para a geracao da CHAVE_INTEGRAGAO deve ser realizada apenas uma vez por proceso e deve acontecer antes de iniciar as integragSes. ‘A mesma CHAVE_INTEGRAGAO gerada na primeira chamada de processo sera usada para todas as paginas da integracdo ativa, ou seja, cada processo inicializado, independentemente da quantidade de paginas, terd apenas uma chave de integracao. MENSAGENS DE RETORNO: Token incorreto ou expirado. Msg: “Token invalido". Autenticago bem-sucedida. msg: Dados validados com sucesso. Parametros de “LOGIN” ou “PASSWORD” nao enviados ou incorretos. msg: Login falhou, por favor verifique login e senha de usuério. INTEGRAGOES © sistema Plano permite realizar a integraco de documentos de realizados para os seguintes médulos: 44 DRE Parametros de envio: on Descrgto Formato Con = Veraadero0 [RUTH.TOKEN Valor verdadero (1) ou fas (0) Falso ‘ CEREINTERAGRO | Chave de erarbo Naners lire | aT eSESSRIER PAGINA Numer a piers maorada Niners ieee | 2 IMPORTACAO Pardmetro deve conter todos dados para Texto livre IMPORTACAO_ imparsie des elas. we Nimer referent ap ms ase" ingore WA @ AN. ime refeente ap ane a serimporade, | ABA 202i DATA Data eta do doce ODMRIAAAR | wanaeGz1 ‘ge do uidae de e460. OI? sos ou nome coo.UNIoADE | temauecomedircomo que est ne re oor “sda nates no ‘Getge do cane de asto ARO | vos ounamera coo.ee queronedrcomoqueeséne casero no | TO oor Sistema ane vsc.ce Desreie do ena Gece RHEE | es ne Crvtlaonis c09,€0NrA lige da cont cons aeanrada no ene | FEMUR SUSE T6905 04.00 onc ean Da 0 A ORT S| oe vag coco NomarorE Ags do doce BRRTads | Testa au nO yg notte tee 3 -DeROTE NATUREZA Nauteradolangarento ope, | ‘VALOE Valor de langamento Numero com 2 -150000,00 KOR or do langamente casas decimais * ATOR ead nearer Tes ie ‘ule de eausarertos eae do projto.0 cao emae | sos oy namera 00 _pROSETO Concaircomoque extn cadnsrone | Tenwaumimero | gg, sistema Plano, Campo no obrigatério, * Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 22544 Plano wwwallstrategy.com.br caunoH Tee RTE EED TEROCURIME | sae Chige do Derata ODTGD UTI | sees oasgnew coo.owenssor | comedircomoaue caine edasrone | Tt ase ‘Sttma ne. a0 Went importaie come ddes de rato. | SSUN-NIOT [5 Os parémetros devem ser passados via “POST”, conforme exemplo: ‘ "AUTH_TOXEN': ey RCIEMTAYMiAsleVNQUIMIia¥/SOZWay"¥VRvel4yMJAYWse3RyYARL3KuY29:Lm yi QVVUSFOUTOLTISIN ‘V2 FSG NHFY Cay TV URS VK GY2OWe Bn WhVycrn ANUFYRANRDEYnKOBenSec3NyQen| heJURKY Ob2zeTywusne TOO "CHAVE INTEGRACAO":"519220720174314883", "PAGINA 1, WPORTACAO™ ‘ Mest", "AN "2622", *DATA':"07/01/2022", *COD_UNIDADE' "Acco", *COD_CC*:"O1CEARASOS", ;DESC.CC'“COMUNICAGKO *cOD_LONTA"8111077, ‘DESC. CONTA’: “EQUIPAMENTOS OF PROTEGAO INDIVIDUAL", ‘DOCUMENTO*: ‘DOCUMENTO TESTE]SON SNATUREZA HISTORICO™: "HISTORICO”, “COD_PROJETO" "010", “GERADOR':"GERADOR' “COD_DIMENSAO': "1007", 4.2 FLUXO DE CAIXA Parametros de envio: om r Formato AUTH TOKEN abr eae 7 a0 eer CHAE_NTEGRAGKO | Chave de egragta Namero re | rer oSSSST Me | PAGINA ‘Numero da pga merida Nimere veka |? | IMP ORTACAO rac deve nt esos aae5 99 | Texolive IMP ORTACAD ve Numero referent 0 més aserinporado | Wt @ AN. Nurrere referent nea sarimporsce | AAA 2 DATAVENGWENTO Ost ge venient go document DDINIIAAAA | oar ego da nid de nego. 0 ARETE | so ou nama 09, UNIDABE uetonedircomoqueestinacadasrona | TO or Stora Pome ‘éalgo do centro de esto, 0 ebalgo tem ue cineir com o que esti no cadasro no ‘reco ounimero COD_CENTRODECUSTO | sistema Plano jes 01 (Obrgstrio quando nao hower centro de custo padrdo cadasrado (Céalgo da cimensao oe nagico. 0 cbaige tem Texto ou ndmero CoD.DIMENSAOT que coineaiecom a queestano cadastro na. | TE ‘ot sistema Plano cou cowa ‘Céalgo da estrutura ou da conta exten teraursud® | yeo1 oncor cadasiva na sistema no, conta exter Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 22544 Plano wwwallstrategy.com.br Taree a a ia sistema Plan. : i rae NinelCbags Ue Gras BSATOTS | Teo HTATRTS ye ‘sistema Plano. livre ae 3 babReTE waza ature do ngamera 0b ° aloe lor do langues, amsiosem? | seonee TORS Tice de ram TecolWe Fauisdo de euhareron Cade poet. 0 SUNDER ya nanan conmoero | emoauewsinwcasetoresinena Mae. | cot Gongondocbgstre ERTRLIGUDACAS [bat deus vo daar aR TE ues oreo a ee Os pardmetros devem ser passados via “POST”, conforme exemplo: ‘ “AUTH, TOXEN': ey RClEMTQyW)gsIeyNQUIMIciaWS0Z¥4dy¥WRucsxODRAWsCSRYYXRIKuY29¢LmylaiQVVUSFOUTORFTISL leNZNn#ZGTLXCILOFTHVARIaE9CLInovko2UGxGokllbGdoeFZ0Mmn 021493 IQhe" bew2dHIxN22Le34VKCDxNOpadrZAVNGS3P pRvasensxxcsiagedz02In0=, CHAVE INTEGRACAO":"518818226173575773", "PAGINA 1, “IwPORTACAO™( ‘ "ANO": "2622", "DATA VENCIMENTO": "01/12/2022", OD_UNIDADE' "ACO", *COD_CENTRODECUSTO™ "3586, ‘COD_CONTA "010", ;DESC.CONTA': "3, *DOCUMENTO" ‘DOCUMENTO TESTE SON *, SNATUREZA' “0 "VALOR: "999.95, HISTORICO': HISTORKO? "DATA.LIQUIOACAO": "01/01/2022", "GERADOR':"GERADOR 43 BALANGO Parametros de envio: SINE ES | twang 1 ae — ROE Nimero de dericagbo do processona Pacina enero dew imeroitere. | sa wwontacna__| period ae OUST Tae od we Numero ree pms sserinporio | NA 2 aN Numer referee ab ss serimporado | ABA 221 a coounioane | temqueconedreomo que esire 1 cadastrono sisters Plane we Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curt contato@allstrategy.com.br | 41 3013 22544 Plano wwwallstrategy.com.br 44 ‘Chige da divensto de neB5C0. OBES | co casragu chee CoD_DIMENSAD | temaue coined como que est no ett ‘adasirono sistema Plane CO0.CONTA ‘Cee da conta contabileadasvada no ERP_| Numero re To ‘Numere com saioo Saldo de balango do mas Namerocom? | 15.0000 Os parametros devem ser passados via “POST”, conforme exemplo: « "AUTH_TOKEN': ey RI6MTOyigskCNQUIMIlaWSOZWay VR vcéxODNAYWaseSRyYARIZSRUY29XLmyhwQVVUSFOUTORTEHC "nlesenRaFaSFBnan cb INKOAYan VER TWwSBXZNTENEMAVMGFRHCOHLZGZCNDY&R2|S81 ModnpqUEM NHpaMWU3CONIEVENQ Sa NIFg0vRL ZI CHAVE INTEGRACAO':"618818226132855279 "PAGINA, oPORTACAOT ‘ owes *ANO": "2022", “€OD_UNIDADE' "ACCO, “cOD_DIMENSAG": "1001", *cOD.CONTAY "010, *SALDO "999.99 CONTRATOS Parametros de envio: = = Es x Valor verdadeiro (1) ou false La Nerdeseno lo 1 Aum To 5. MENSAGENS PADROES DE RETORNO. Validos para os médulos: © DRE, * Fluxo de caixa. Recursos humanos mensalista. * Recursos humanos horista, * Balango. Token esté incorreto ou expirado. Msg: "Token invalido". Chave de identificagao incorreta. Msg: “Nao existe processo ativo com a chave informadal” Pardmetro “COMPETENCIA” néo informado. Msg: “Campos obrigatérios: Competéncia”. Competéncia selecionada est bloqueada para importagao. Msg: “Problemas encontrados: Nao foi possivel realizar a importaco do realizado [NOME DO MODULO}! A competéncia selecionada esta bloqueada para importacio.”. Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@alistrategy.com.br | 41 3013 22544 Plano eomclnantusmnis Campos para importacao vazios. Msg: “Problemas encontrados: Importasao vazia!”. Pardmetros enviados com sucesso. Msg: Dados validados com sucesso. CEPP_ID: Numero de identificacao do processo na Central de processos. 6. ACOMPANHAMENTO NA CENTRAL DE PROCESSOS © acompanhamento serd realizado através da central de processos. BB rocessos Informagées apresentadas na central: ID - Ser apresentado 0 id do proceso, descrito no parametro de retorno da API. Processo - Sera apresentado o nome do processo informando ao usuario o nome do médulo. Usuério - 0 usudrio ser apresentado como integrador. Data/hora inicio - Sera apresentado a data e hora inicio da integraco via API. Duragao- Seré apresentada a duracao do processo. Rua Gen, Mario Tourinho, 1746 - 11° andar - Bigorrilho, Curitiba/PR contato@allstrategy.com.br | 41 3013 2254