{"info":{"_postman_id":"934aa41e-5f72-4986-4aa4-129c864dfe58","name":"Allgoo API Advisor","description":"Esta é a nossa documentação da API do Robô Advisor. O endpoint é responsável pelas simulações com/sem meta financeira.\n\nTodas as consultas consomem e retornam conteúdos JSON (application/json).\n\n**USO DA API**\n\nPara implementação da API em seu sitema, selecione na coluna ao lado a linguagem de programação que gostaria de usar para fazer requisições aos endpoints. Códigos de exemplo serão gerados ao lado de cada endpoint para auxiliá-lo na implementação.\nPara uma implementação alternativa da API, utilize o Postman clicando em *Run in Postman*.\n\nDisponibilizamos uma interface gráfica para você ver o funcionamento da nossa API. O link é o: https://apis.allgoo.com.br/advisor.\n\nA seguir serão listadas algumas observações, parâmetros de entrada, exemplo de retorno e cenários utilizando a nossa API.\n\n**OBSERVAÇÕES**\n\n- Para a simulação e execução de carteiras é necessário que você cadastre os produtos da sua instituição financeira utilizando nossa API de Produtos. O link da documentação é: https://documenter.getpostman.com/view/2843755/produtos/RVfzeTig\n- Nossa API do Advisor considera os prazos em meses.\n- Clique nas tabelas/imagens para visualizar todas as informações.\n\n**PARÂMETROS DE ENTRADA**\n\nVocê deve enviar sua API Key no Header como ```x-api-key``` e os seguintes parâmetros no Body:\n\n| Chave | Descrição |\n| ------ | ------ |\n| agroup_fixed_incomes * | Agrupar Produtos Renda Fixa em um único produto? (S/N) |\n| agroup_products | Agrupar Produtos de acordo com tipo e classe? (S/N) |\n| deadline * | Prazo |\n| deduce_income_tax * | Deduzir Imposto de Renda? (S/N) |\n| financial_goal + | Meta Financeira |\n| full_percentage_cdi * | Produtos Renda Fixa e COE com 100% CDI? (S/N) |\n| initial_capital * | Capital Inicial |\n| investment_period * | Investimento Mensal |\n| investment_profile * | Perfil de Investidor |\n| save_investment * | Gerar somente simulação sem gráfico de projeções? (S/N) |\n| max_deadline + | Prazo máximo que a API utilizará para sugerir carteiras |\n| name * | Nome para a carteira |\n| only_projections * | Somente a simulação sem meta financeira? (S/N) |\n| lock_deadline ++ | Travar títulos de Renda Fixa de acordo com o prazo informado pelo cliente? (S/N) |\n| closest_due_date ++ | Travar títulos de Renda Fixa de acordo com o prazo de vencimento mais próximo? (S/N) |\n\n(*) campo obrigatório\n\n(+) campo obrigatório em determinados cenários (vide **OBSERVAÇÕES**)\n\n( ++ ) Caso seja enviado os dois campos como *S*, será utilizado somente o campo *lock_deadline*.\n\n**EXEMPLO DE RETORNO**\n\n- Código: 200\n- Conteúdo:\n\n| Chave | Descrição |\n| ------ | ------ |\n| capital_invest | Capital Investido |\n| cdi_rate | Taxa CDI |\n| deadline | Prazo |\n| deadline_achive_goal | Booleano que indica que o cliente alcançou a meta no prazo estipulado |\n| financial_assets | Produtos da carteira |\n| financial_goal | Meta Financeira |\n| gross_value_projection | Projeção Bruta do Investimento |\n| initial_capital | Capital Inicial |\n| investment_chart_projection | Array com as projeções do investimento de cada período |\n| investment_goal_id | ID da Carteira |\n| investment_goal_name | Nome da Carteira |\n| investment_period | Investimento Mensal |\n| ipca_rate | Taxa IPCA |\n| message | Mensagem |\n| net_value_projection | Projeção Líquida do Investimento |\n| recurring_product | Produto utilizado para aplicação recorrente |\n| savings_chart_projection | Array com as projeções do investimento de cada período |\n| savings_projection | Projeção da Poupança |\n| savings_rate | Taxa Poupança |\n| success | Cenário é impeditivo? |\n| value_achive_goal | Projeção do investimento de quando o cliente alcançou a meta no prazo estimupulado |\n| value_achive_goal_savings | Projeção da poupança de quando o cliente alcançou a meta no prazo estimupulado |\n\n\n**OBSERVAÇÕES:**\n- A chave **financial_goal** deixa de ser obrigatória se a chave **only_projections** for **S**.\n- Se não for enviada a chave **max_deadline**, será considerado o prazo máximo de 999 meses.\n- Caso seja enviado **agroup_products** como **S** e **agroup_fixed_incomes** como **N**, o retorno do **financial_assets** será um JSON ao invés de uma lista.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Cenário 1","item":[{"name":"Cenário 1","id":"43d2e2db-9bdc-9379-eea3-120b6e3045c9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"<sua api_key>"}],"body":{"mode":"raw","raw":"{\r\n  \"financial_goal\": 250000,\r\n  \"initial_capital\": 50000,\r\n  \"investment_period\": 3000,\r\n  \"deadline\": 60,\r\n  \"save_investment\": \"N\",\r\n  \"investment_profile\": \"conservador\",\r\n  \"name\": \"Cenario 1\",\r\n  \"deduce_income_tax\": \"S\",\r\n  \"full_percentage_cdi\": \"S\",\r\n  \"agroup_fixed_incomes\": \"S\",\r\n  \"max_deadline\": 120,\r\n  \"only_projections\": \"N\"\r\n}"},"url":"https://apis.allgoo.com.br/advisor/v2.3"},"response":[],"_postman_id":"43d2e2db-9bdc-9379-eea3-120b6e3045c9"}],"id":"e349ab16-2ee5-2b6b-808e-0cceb02bac6b","description":"Este cenário consiste nos seguintes parâmetros:\n  - Nome do Objetivo: **Cenário 1**\n  - Objetivo Financeiro: **R$ 250.000**\n  - Capital Inicial: **R$ 50.000**\n  - Investimento Mensal: **R$ 3.000**\n  - Prazo: **60 meses**\n  - Deduzir IR: **Sim**\n  - Produtos Renda Fixa e COE com 100% CDI: **Sim**\n  - Agrupar Produtos Renda Fixa: **Sim**\n  - Prazo Máximo: **120 meses**\n  - Somente Projeção: **Não**","event":[{"listen":"prerequest","script":{"id":"989e5da7-5df4-4ec3-bec5-8697b82a2ae6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3ddd5511-e8ac-470f-95af-46b86eeed5ec","type":"text/javascript","exec":[""]}}],"_postman_id":"e349ab16-2ee5-2b6b-808e-0cceb02bac6b"},{"name":"Cenário 2","item":[{"name":"Cenário 2","id":"38c1ffb7-1bd7-12af-19ed-1e3348097580","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"<sua api_key>"}],"body":{"mode":"raw","raw":"{\r\n  \"initial_capital\": 8000,\r\n  \"investment_period\": 3000,\r\n  \"deadline\": 10,\r\n  \"save_investment\": \"N\",\r\n  \"investment_profile\": \"conservador\",\r\n  \"name\": \"Cenario 2\",\r\n  \"deduce_income_tax\": \"N\",\r\n  \"full_percentage_cdi\": \"S\",\r\n  \"agroup_fixed_incomes\": \"N\",\r\n  \"agroup_products\": \"S\",\r\n  \"max_deadline\": 120,\r\n  \"only_projections\": \"S\"\r\n}"},"url":"https://apis.allgoo.com.br/advisor/v2.3"},"response":[],"_postman_id":"38c1ffb7-1bd7-12af-19ed-1e3348097580"}],"id":"f567c0ab-cc87-2066-425b-d88825c8413d","description":"Este cenário consiste nos seguintes parâmetros:\n  - Nome do Objetivo: **Cenário 2**\n  - Capital Inicial: **R$ 8.000**\n  - Investimento Mensal: **R$ 3.000**\n  - Prazo: **10 meses**\n  - Deduzir IR: **Não**\n  - Produtos Renda Fixa e COE com 100% CDI: **Sim**\n  - Agrupar Produtos Renda Fixa: **Não**\n  - Agrupar Produtos: **Sim**\n  - Prazo Máximo: **120 meses**\n  - Somente Projeção: **Sim**","event":[{"listen":"prerequest","script":{"id":"0a52874a-8e90-4e75-aa97-84a21a55588d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a9a6043f-1959-4551-9bd6-6f0428f7bffd","type":"text/javascript","exec":[""]}}],"_postman_id":"f567c0ab-cc87-2066-425b-d88825c8413d"},{"name":"Cadastro Produtos","item":[{"name":"COE","item":[{"name":"Exemplo","id":"074280cd-ffff-4bc8-9f8e-46191ca0044f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/coe"},"response":[],"_postman_id":"074280cd-ffff-4bc8-9f8e-46191ca0044f"},{"name":"Cadastrar","id":"64bd4a5d-0ece-4b54-952b-54504aa82357","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"<sua api_key>","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <seu_token>","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"arquivo","type":"file","value":null},{"key":"is_pension","value":"false","type":"text"}]},"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/coe"},"response":[],"_postman_id":"64bd4a5d-0ece-4b54-952b-54504aa82357"}],"id":"b315c4d2-f5db-4213-b37e-f016e48e00b4","_postman_id":"b315c4d2-f5db-4213-b37e-f016e48e00b4"},{"name":"Renda Fixa","item":[{"name":"Cadastrar","id":"19ca0076-c7e8-44e3-8d6c-cceeafa7d2ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"<sua api_key>","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <seu_token>","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"arquivo","type":"file","value":null},{"key":"is_pension","value":"false","type":"text"}]},"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/fixed-incomes"},"response":[],"_postman_id":"19ca0076-c7e8-44e3-8d6c-cceeafa7d2ce"},{"name":"Exemplo","id":"f5f2a5a1-e76a-4b69-8cc4-ecc514f06243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"<sua api_key>","type":"text"}],"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/fixed-incomes"},"response":[],"_postman_id":"f5f2a5a1-e76a-4b69-8cc4-ecc514f06243"}],"id":"03e22714-97fa-4eb1-90b1-93de04447466","event":[{"listen":"prerequest","script":{"id":"41dcb10d-1d27-4a3e-b090-c5fef6af4909","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b02bcd58-300e-4454-b7f3-14a6259ee24a","type":"text/javascript","exec":[""]}}],"_postman_id":"03e22714-97fa-4eb1-90b1-93de04447466"},{"name":"Fundos Investimento","item":[{"name":"Exemplo","id":"20f6ac7d-9b7d-40ce-a4c2-a60a608a60a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"<sua api_key>","type":"text"}],"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/investment-funds"},"response":[],"_postman_id":"20f6ac7d-9b7d-40ce-a4c2-a60a608a60a6"},{"name":"Cadastrar","id":"ac8bc993-29aa-4ea8-9d71-859f8bbe73eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"<sua api_key>"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer <seu_token>"}],"body":{"mode":"formdata","formdata":[{"key":"arquivo","type":"file","value":null},{"key":"is_pension","type":"text","value":"false"}]},"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/investment-funds","description":"Caso não exista o fundo na CVM retornará uma lista dos produtos não encontrados"},"response":[],"_postman_id":"ac8bc993-29aa-4ea8-9d71-859f8bbe73eb"}],"id":"f98f5b17-c248-4e3a-a6fd-16e9b0a75bb6","event":[{"listen":"prerequest","script":{"id":"41dcb10d-1d27-4a3e-b090-c5fef6af4909","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b02bcd58-300e-4454-b7f3-14a6259ee24a","type":"text/javascript","exec":[""]}}],"_postman_id":"f98f5b17-c248-4e3a-a6fd-16e9b0a75bb6"},{"name":"Tesouro Direto","item":[{"name":"Exemplo","id":"81e1f898-267a-420d-95e3-5b540da29b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"<sua api_key>","type":"text"}],"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/treasury-bonds"},"response":[],"_postman_id":"81e1f898-267a-420d-95e3-5b540da29b3c"},{"name":"Cadastrar","id":"5035abfd-e3f0-4797-8ecc-6a0194c85811","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"<sua api_key>","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <seu_token>","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"arquivo","type":"file","value":null},{"key":"is_pension","value":"false","type":"text"}]},"url":"https://apis.allgoo.com.br/advisor/parametrization/client-products/treasury-bonds","description":"Caso não exista o tesouro no site do governo retornará uma lista dos produtos não encontrados"},"response":[],"_postman_id":"5035abfd-e3f0-4797-8ecc-6a0194c85811"}],"id":"7fad9d65-9332-45b8-ad7d-2e57c1facec8","event":[{"listen":"prerequest","script":{"id":"41dcb10d-1d27-4a3e-b090-c5fef6af4909","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b02bcd58-300e-4454-b7f3-14a6259ee24a","type":"text/javascript","exec":[""]}}],"_postman_id":"7fad9d65-9332-45b8-ad7d-2e57c1facec8"}],"id":"0d101229-ed8b-4ab5-8211-060960720224","description":"Endpoints responsáveis pelo cadastros dos produtos.\n\n**PARÂMETROS DE ENTRADA**\n\nVocê deve enviar sua API Key como ```x-api-key``` e seu Token **¹** válido como ```Bearer <seu_token>``` no Header.\n\nPara a obtenção do token por favor consulte nossa documentação: https://documenter.getpostman.com/view/2843755/RzfarrW7\n\n| Chave | Descrição |\n| ------ | ------ |\n| arquivo * | Planilha .xlsx com os produtos |\n| is_pension * | Flag identificando se os produtos são para Previdência Privada (true / false) |\n\n(*) campo obrigatório","event":[{"listen":"prerequest","script":{"id":"01b86ba8-62bc-4ea3-aba9-bc2dde8b7a3d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ee11754-49a8-49da-ab36-d3db779e08da","type":"text/javascript","exec":[""]}}],"_postman_id":"0d101229-ed8b-4ab5-8211-060960720224"}],"event":[{"listen":"prerequest","script":{"id":"c21834c4-8696-4c1c-87a4-881b7707d3d4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"abbcda63-5854-45d7-af04-c57ab1265320","type":"text/javascript","exec":[""]}}]}