{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"TypeScript","type":"basic","slug":"typescript","excerpt":"Saiba como instalar e configurar nossa SDK em TypeScript para API Pix e API Boletos (Bolix)","body":"[block:html]\n{\n  \"html\": \"<p>Nossa API é <a href=\\\"https://en.wikipedia.org/wiki/Representational_state_transfer\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">RESTful</a> e responde em <a href=\\\"http://www.json.org/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">JSON</a>. A Gerencianet utiliza <a href=\\\"http://oauth.net/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">OAuth</a> para fornecer acesso autorizado à <abbr title=\\\"Application Programming Interface\\\">API</abbr>. Nossa SDK de TypeScript já está preparada para realizar essa autenticação automaticamente.</p>\"\n}\n[/block]\nA seguir, confira os procedimentos para instalação da <a href=\"https://github.com/gerencianet/gn-api-sdk-typescript\" target=\"_blank\" title=\"Link Externo\">SDK da Gerencianet em TypeScript</a>:\n\n# Instalando via NPM\n\n<pre>$ npm install gn-api-sdk-typescript</pre>\n\n# Testado com\n\n- Version <code>4.2.4</code>\n\n<br>\n\n #Uso Básico\n\nImporte o módulo:\n\n<pre>import Gerencianet from 'gn-api-sdk-typescript';</pre>\n\n<br>\n\nInsira suas credenciais e defina se deseja usar o sandbox ou não. Você também pode usar o arquivo  <a href=\"https://github.com/gerencianet/gn-api-sdk-typescript/blob/main/examples/config.ts\" target=\"_blank\">examples/config.ts</a> de modelo.\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"export = {\\n\\t// PRODUÇÃO = false\\n\\t// HOMOLOGAÇÃO = true\\n\\tsandbox: false,\\n\\n\\t// CREDENCIAIS DE PRODUÇÃO\\n\\tclientIdProducao: '',\\n\\tclientSecretProducao: '',\\n\\tpathCertProducao: '',\\n\\n\\t// CREDENCIAIS DE HOMOLOGAÇÃO\\n\\tclientIdHomologacao: '',\\n\\tclientSecretHomologacao: '',\\n\\tpathCertHomologacao: '',\\n\\n\\t// VALIDAR MTLS?\\n\\tvalidateMtls: false,\\n};\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"TypsScript\"\n    }\n  ]\n}\n[/block]\n<br>\nInstancie o módulo passando suas options:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"const gerencianet = Gerencianet(options);\",\n      \"language\": \"javascript\",\n      \"name\": \"TypeScript\"\n    }\n  ]\n}\n[/block]\n<br>\n\nCrie a *charge* (transação):\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var body = {\\n  items: [{\\n    name: 'Product A',\\n    value: 1000,\\n    amount: 2\\n  }]\\n}\\n\\ngerencianet\\n  .createCharge({}, body)\\n  .then(console.log)\\n  .catch(console.log)\\n  .done();\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"TypeScript\"\n    }\n  ]\n}\n[/block]\n# Exemplos\n\nPara executar os exemplos, clone este repositório e instale as dependências:\n\n<pre>$ git clone git:::at:::github.com:gerencianet/gn-api-sdk-typescript.git\n$ cd gn-api-sdk-typescript/examples\n$ npm install\n</pre>\n\n<br>\n\nDefina suas credenciais em config.ts:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"export = {\\n\\t// PRODUÇÃO = false\\n\\t// HOMOLOGAÇÃO = true\\n\\tsandbox: false,\\n\\n\\t// CREDENCIAIS DE PRODUÇÃO\\n\\tclientIdProducao: '',\\n\\tclientSecretProducao: '',\\n\\tpathCertProducao: '',\\n\\n\\t// CREDENCIAIS DE HOMOLOGAÇÃO\\n\\tclientIdHomologacao: '',\\n\\tclientSecretHomologacao: '',\\n\\tpathCertHomologacao: '',\\n\\n\\t// VALIDAR MTLS?\\n\\tvalidateMtls: false,\\n};\\n\",\n      \"language\": \"json\",\n      \"name\": \"config.ts\"\n    }\n  ]\n}\n[/block]\nEm seguida, execute o exemplo que você deseja:\n\n<pre>$ ts-node createCharge.ts</pre>","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60f03345093880000f837bb1","createdAt":"2021-07-15T13:08:21.346Z","user":"5e8b36bc27ee9b00181b36bf","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Instalação da API (SDK's)","slug":"instalação-da-api-sdks","order":6,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba91007878343d","createdAt":"2017-03-10T12:37:05.075Z","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6","__v":0},"version":{"version":"1.1.0","version_clean":"1.1.0","codename":"2021","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["606f2ca6c5ba91007878342b","575af039a083950e004487f7","575af5c7ba4ed70e000ca288","606f2ca6c5ba91007878342c","606f2ca6c5ba91007878342d","606f2ca6c5ba91007878342e","606f2ca6c5ba91007878342f","5761a63d207db7170022fc14","5761b9a2b65324200072d79e","576832939f0bf4190014ffdf","576832c09f0bf4190014ffe1","576832cba151c10e004316f0","576832d5bb15f40e00a288ec","576832e107b1f30e0039c645","606f2ca6c5ba910078783430","606f2ca6c5ba910078783431","5783f78c5cbce30e0074e2b7","606f2ca6c5ba910078783432","606f2ca6c5ba910078783433","606f2ca6c5ba910078783434","606f2ca6c5ba910078783435","606f2ca6c5ba910078783436","606f2ca6c5ba910078783437","578529f887c9280e0090394b","606f2ca6c5ba910078783438","606f2ca6c5ba910078783439","606f2ca6c5ba91007878343a","606f2ca6c5ba91007878343b","606f2ca6c5ba91007878343c","606f2ca6c5ba91007878343d","606f2ca6c5ba91007878343e","606f2ca6c5ba91007878343f","606f2ca6c5ba910078783440","606f2ca6c5ba910078783441","60d61f026ddc3901a32ee5f1","60ec37c637005f015e54174e"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":2,"forked_from":"575aeffae12cf20e002f306f"},"project":"575aeffae12cf20e002f306c","__v":0,"parentDoc":null}

TypeScript

Saiba como instalar e configurar nossa SDK em TypeScript para API Pix e API Boletos (Bolix)

[block:html] { "html": "<p>Nossa API é <a href=\"https://en.wikipedia.org/wiki/Representational_state_transfer\" target=\"_blank\" title=\"Link Externo\">RESTful</a> e responde em <a href=\"http://www.json.org/\" target=\"_blank\" title=\"Link Externo\">JSON</a>. A Gerencianet utiliza <a href=\"http://oauth.net/\" target=\"_blank\" title=\"Link Externo\">OAuth</a> para fornecer acesso autorizado à <abbr title=\"Application Programming Interface\">API</abbr>. Nossa SDK de TypeScript já está preparada para realizar essa autenticação automaticamente.</p>" } [/block] A seguir, confira os procedimentos para instalação da <a href="https://github.com/gerencianet/gn-api-sdk-typescript" target="_blank" title="Link Externo">SDK da Gerencianet em TypeScript</a>: # Instalando via NPM <pre>$ npm install gn-api-sdk-typescript</pre> # Testado com - Version <code>4.2.4</code> <br> #Uso Básico Importe o módulo: <pre>import Gerencianet from 'gn-api-sdk-typescript';</pre> <br> Insira suas credenciais e defina se deseja usar o sandbox ou não. Você também pode usar o arquivo <a href="https://github.com/gerencianet/gn-api-sdk-typescript/blob/main/examples/config.ts" target="_blank">examples/config.ts</a> de modelo. [block:code] { "codes": [ { "code": "export = {\n\t// PRODUÇÃO = false\n\t// HOMOLOGAÇÃO = true\n\tsandbox: false,\n\n\t// CREDENCIAIS DE PRODUÇÃO\n\tclientIdProducao: '',\n\tclientSecretProducao: '',\n\tpathCertProducao: '',\n\n\t// CREDENCIAIS DE HOMOLOGAÇÃO\n\tclientIdHomologacao: '',\n\tclientSecretHomologacao: '',\n\tpathCertHomologacao: '',\n\n\t// VALIDAR MTLS?\n\tvalidateMtls: false,\n};\n", "language": "javascript", "name": "TypsScript" } ] } [/block] <br> Instancie o módulo passando suas options: [block:code] { "codes": [ { "code": "const gerencianet = Gerencianet(options);", "language": "javascript", "name": "TypeScript" } ] } [/block] <br> Crie a *charge* (transação): [block:code] { "codes": [ { "code": "var body = {\n items: [{\n name: 'Product A',\n value: 1000,\n amount: 2\n }]\n}\n\ngerencianet\n .createCharge({}, body)\n .then(console.log)\n .catch(console.log)\n .done();\n", "language": "javascript", "name": "TypeScript" } ] } [/block] # Exemplos Para executar os exemplos, clone este repositório e instale as dependências: <pre>$ git clone [email protected]:gerencianet/gn-api-sdk-typescript.git $ cd gn-api-sdk-typescript/examples $ npm install </pre> <br> Defina suas credenciais em config.ts: [block:code] { "codes": [ { "code": "export = {\n\t// PRODUÇÃO = false\n\t// HOMOLOGAÇÃO = true\n\tsandbox: false,\n\n\t// CREDENCIAIS DE PRODUÇÃO\n\tclientIdProducao: '',\n\tclientSecretProducao: '',\n\tpathCertProducao: '',\n\n\t// CREDENCIAIS DE HOMOLOGAÇÃO\n\tclientIdHomologacao: '',\n\tclientSecretHomologacao: '',\n\tpathCertHomologacao: '',\n\n\t// VALIDAR MTLS?\n\tvalidateMtls: false,\n};\n", "language": "json", "name": "config.ts" } ] } [/block] Em seguida, execute o exemplo que você deseja: <pre>$ ts-node createCharge.ts</pre>