Essa documentação é um guia que mostra como realizar a integração da nossa API com o back-end da sua empresa.
\nCaso surjam dúvidas durante o processo de integração, entre em contato diretamente com o nosso time de desenvolvimento através do e-mail:
\n\nO domínio da Simpaul API de homologação: url: https://stg-gapi.simpaul.com.br/stg/.
\nO domínio da Simpaul API de produção: url: https://gapi.simpaul.com.br/prd/.
\nSerá referenciado como baseUrl.
\nVeja aqui como começar a realizar chamadas nas diferentes APIs disponibilizadas pela Simpaul API.
\nPara fazer uma consulta, basta enviar uma requisição para a URL da API que você deseja consultar, passando os parâmetro necessários para cara consulta e o seu token de acesso.
\nO exemplo abaixo mostra como executar uma consulta a API de pessoas para recuperar os dados básicos associados a um CPF.
\nFormalmente, a requisição de consulta suporta quatro parâmetros, conforme a tabela abaixo:
\nGET: {baseUrl}/investor-v2/client/filter/{filter}/value/{value}
\nOnde:
\nExemplo: \nhttps://stg-gapi.simpaul.com.br/stg/investor-v2/client/filter/cpf/value/12345678901
\nPara cada chamada, será necessário passar o Authorization jwtToken no Header.
\nEste jwtToken é obtido chamando o endpoint security/user/login pelo response body.idToken.jwtToken
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13382369","collectionId":"7f7fbbd9-8ea2-4d2a-89ea-f50abd2f92d2","publishedId":"Tzedf4Ao","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4CAAE2"},"publishDate":"2021-06-24T18:18:46.000Z"},"item":[{"name":"API Securança","item":[{"name":"Obter token","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200 or 201\", () => {\r"," pm.expect(pm.response.code).to.be.oneOf([201,200, 204]);\r","});\r","\r","pm.test(\"Test check token and set on environment\", () => {\r"," pm.expect(pm.response.json().token).exist; \r"," pm.globals.set(\"jwtToken\", pm.response.json().token);\r","});"],"type":"text/javascript","id":"b612c898-b986-4e54-8b2d-23d7259100ce"}}],"id":"fbdc5a53-08e7-4acf-a655-58b55e1ca590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"login\": \"xxxxxx\", \n \"password\": \"xxxxxxx\"\n}\n"},"url":"https://stg-gapi.simpaul.com.br/stg/security/token","urlObject":{"path":["security","token"],"host":["https://stg-gapi.simpaul.com.br/stg"],"query":[],"variable":[]}},"response":[{"id":"a652a6f7-c443-492d-ab3a-2b55876ccb69","name":"200 reponse","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"login\": \"login\",\n\t\"password\": \"password\"\n}"},"url":"{{baseURL}}/security/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 12 Mar 2021 15:04:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"518-OehG/ZpuEoxQn+3h3KOfP2oOMMU\""},{"key":"X-Amz-Apigw-Id","value":"cFFltFBzoAMFj8Q="},{"key":"X-Amzn-Remapped-Connection","value":"close"},{"key":"X-Amzn-Remapped-Content-Length","value":"1304"},{"key":"X-Amzn-Remapped-Date","value":"Fri, 12 Mar 2021 15:04:18 GMT"},{"key":"X-Amzn-Requestid","value":"52d03f91-95a6-4272-9040-d9a1da3dedaa"},{"key":"X-Amzn-Trace-Id","value":"Root=1-604b82f1-497adb3f598a69853eb50319;Sampled=0"},{"key":"X-Powered-By","value":"Express"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"08c890940c0000f7642f9b3000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"62edea001b2ef764-GRU"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJraWQiOiJnVmhhyOEJSZTBaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfbGJIdm50TkkzIiwicGhvbmVfbnVtYmVyX3ZlcmlmaWVkIjpmYWxzZSwiY29nbml0bzp1c2VybmFtZSI6IjIxNzE5NjQzMDAwMTYwIiwiYXVkIjoiMWt2Z2x0dmNiczN0Zj=\"\n}"}],"_postman_id":"fbdc5a53-08e7-4acf-a655-58b55e1ca590"}],"id":"b8ca649e-34d8-4531-9c31-3b06c870a5bb","description":"Security Api
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0728efe5-191e-4650-bf39-ddae781cef0e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"48c875d8-c15b-4c4c-bac7-c8a43f086e2b"}}],"_postman_id":"b8ca649e-34d8-4531-9c31-3b06c870a5bb"},{"name":"API Clientes","item":[{"name":"Consultar cliente por CPF","id":"1576d2b5-2d4f-4023-b617-27eceabe25c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://stg-gapi.simpaul.com.br/stg/investor-v2/client/filter/{filter}/value/{value}","description":"Serviço que retorna uma lista de cliente de um assessor.
\n","urlObject":{"path":["advisor","asset-manager","clients"],"host":["https://stg-gapi.simpaul.com.br/stg"],"query":[],"variable":[]}},"response":[{"id":"206ed3a5-fc09-4af5-b3bf-674eef83df86","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"","value":"","type":"text"}],"url":"https://stg-gapi.simpaul.com.br/stg/advisor/asset-manager/clients"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jun 2021 17:29:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"81"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"51-/ozVn+tOL86AEcmEx+i/r0YbA4s\""},{"key":"X-Amz-Apigw-Id","value":"BcMVuEFdGjQFiCg="},{"key":"X-Amzn-Remapped-Connection","value":"close"},{"key":"X-Amzn-Remapped-Content-Length","value":"81"},{"key":"X-Amzn-Remapped-Date","value":"Thu, 24 Jun 2021 17:29:21 GMT"},{"key":"X-Amzn-Requestid","value":"6cc41f56-4f64-4294-85a8-c90ba83902cc"},{"key":"X-Amzn-Trace-Id","value":"Root=1-60d4c0f1-2b59dc3f186119125fb003f0;Sampled=0"},{"key":"X-Powered-By","value":"Express"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"0ae0aac64e00004b2ffe850000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6647ad83ad014b2f-GRU"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"ERR_AUTHORIZATION_NOT_ROLES\"\n}"},{"id":"b816f570-7231-4d03-b4fd-08928bb43746","name":"200 Response","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"","value":"","type":"text"}],"url":"https://stg-gapi.simpaul.com.br/stg/advisor/asset-manager/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jun 2021 17:33:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"11c-ho2cu5cixxU90w1qhC5ukbe4WVg\""},{"key":"X-Amz-Apigw-Id","value":"BcM8SG1FGjQFTiA="},{"key":"X-Amzn-Remapped-Connection","value":"close"},{"key":"X-Amzn-Remapped-Content-Length","value":"284"},{"key":"X-Amzn-Remapped-Date","value":"Thu, 24 Jun 2021 17:33:28 GMT"},{"key":"X-Amzn-Requestid","value":"ea428aca-49d5-454e-82ce-c433fec97cbc"},{"key":"X-Amzn-Trace-Id","value":"Root=1-60d4c1e8-5fb1c06744d9872a6c51e053;Sampled=0"},{"key":"X-Powered-By","value":"Express"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"0ae0ae8a8000004b2f582f1000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6647b38a6d764b2f-GRU"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"8368\",\n \"cpf\": \"05195759979\",\n \"name\": \"Jailon Rogério Giacomelli\",\n \"sinaccount\": \"139307\",\n \"fldefault\": true,\n \"advisorcode\": 3009,\n \"advisorid\": 3064\n },\n {\n \"id\": \"8367\",\n \"cpf\": \"91000530906\",\n \"name\": \"Tatiana Basso Biasi\",\n \"sinaccount\": \"166800\",\n \"fldefault\": true,\n \"advisorcode\": 3009,\n \"advisorid\": 3064\n }\n]"}],"_postman_id":"95d2fd55-321c-4af5-8dca-742fcebfee0e"}],"id":"dd19deec-a91a-4f0b-b49a-8fe39e5e73f7","_postman_id":"dd19deec-a91a-4f0b-b49a-8fe39e5e73f7","description":""}],"variable":[{"key":"baseUrl","value":"https://stg-gapi.simpaul.com.br/stg","type":"string"}]}