2414498b.afc42e98.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{132:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return r})),n.d(t,"metadata",(function(){return l})),n.d(t,"rightToc",(function(){return c})),n.d(t,"default",(function(){return s}));var a=n(2),o=n(6),i=(n(0),n(250)),r=(n(252),{id:"BoxBilling",title:"Box Billing",hide_title:!0,sidebar_label:"Box Billing"}),l={id:"Modulos/BoxBilling",isDocsHomePage:!1,title:"Box Billing",description:"Box Billing",source:"@site/docs\\Modulos\\BoxBilling.md",permalink:"/documentation/docs/Modulos/BoxBilling",sidebar_label:"Box Billing",sidebar:"someSidebar",previous:{title:"Introdu\xe7\xe3o",permalink:"/documentation/docs/Modulos/IntroducaoModulos"},next:{title:"Joomla (VirtueMart)",permalink:"/documentation/docs/Modulos/Joomla"}},c=[{value:"1. Requirements",id:"1-requirements",children:[]},{value:"2. Installation",id:"2-installation",children:[{value:"Module settings",id:"module-settings",children:[]}]},{value:"3. Common Integration Errors",id:"3-common-integration-errors",children:[]}],b={rightToc:c};function s(e){var t=e.components,n=Object(o.a)(e,["components"]);return Object(i.b)("wrapper",Object(a.a)({},b,n,{components:t,mdxType:"MDXLayout"}),Object(i.b)("h1",{className:"titulo"},"Box Billing"),Object(i.b)("div",{className:"subtitulo"},Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"Gerencianet Integration Module for Official Boxbilling - Version 0.2.1 (Beta)")),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"The Gerencianet module for Boxbilling allows you to generate charges with registration through our API.")," Compatible with versions above 4.19 of Boxbilling."),Object(i.b)("p",null,"This is a Beta version of the Official Integration Module provided by Gerencianet for ",Object(i.b)("strong",{parentName:"p"},"Boxbilling"),". With it, the person responsible for the ",Object(i.b)("strong",{parentName:"p"},"Box Billing")," account can receive payments by boleto and, as soon as the charge has a payment confirmation or is cancelled, Gerencianet sends an automatic notification to Boxbilling."),Object(i.b)("p",null,"If you have any questions or suggestions, please contact us through the Gerencianet website."),Object(i.b)("div",{className:"admonition admonition-important alert alert--info"},Object(i.b)("div",Object(a.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(a.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(a.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"}),Object(i.b)("path",Object(a.a)({parentName:"svg"},{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})))),"Bolix")),Object(i.b)("div",Object(a.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"If you have activated Bolix in your Gerencianet account, the charges generated by our module/plugin will already come with the pix on the boleto.\nMore details about Bolix and how to activate it, click ",Object(i.b)("a",Object(a.a)({parentName:"p"},{href:"../Bolix/bolix"}),"here"),"."))),Object(i.b)("br",null),Object(i.b)("h2",{id:"1-requirements"},"1. Requirements"),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"PHP version: ",Object(i.b)("inlineCode",{parentName:"li"},"5.4.39")," \xe0 ",Object(i.b)("inlineCode",{parentName:"li"},"7.0.3")),Object(i.b)("li",{parentName:"ul"},"Minimal version of Boxbilling: ",Object(i.b)("inlineCode",{parentName:"li"},"4.19"))),Object(i.b)("br",null),Object(i.b)("hr",null),Object(i.b)("h2",{id:"2-installation"},"2. Installation"),Object(i.b)("ol",null,Object(i.b)("li",{parentName:"ol"},Object(i.b)("p",{parentName:"li"},"Download the ",Object(i.b)("a",{href:"https://codeload.github.com/gerencianet/gn-api-boxbilling/zip/master",target:"_blank",title:"Efetuar Download"},"latest module version"),";")),Object(i.b)("li",{parentName:"ol"},Object(i.b)("p",{parentName:"li"},"Unzip the downloaded file;")),Object(i.b)("li",{parentName:"ol"},Object(i.b)("p",{parentName:"li"},"Copy the file ",Object(i.b)("code",null,"gerencianetcharge.php")," and the folder ",Object(i.b)("code",null,"gerencianet_lib")," (available in the folder ",Object(i.b)("code",null,"gn-api-boxbilling"),") and paste in the directory ",Object(i.b)("code",null,"/bb-library/Payment/Adapter/")," of the installation of Box Billing;")),Object(i.b)("li",{parentName:"ol"},Object(i.b)("p",{parentName:"li"},"Copy the image ",Object(i.b)("code",null,"gerencianetcharge.png")," (available in the folder ",Object(i.b)("code",null,"gn-api-boxbilling"),") and paste in the directory ",Object(i.b)("code",null,"/bb-themes/huraga/assets/img/gateway_logos"),";")),Object(i.b)("li",{parentName:"ol"},Object(i.b)("p",{parentName:"li"},"At the end of the file ",Object(i.b)("code",null,"logos.css"),", located in the directory ",Object(i.b)("code",null,"/bb-themes/huraga/assets/css/"),", paste the following code snippet:"))),Object(i.b)("pre",null,Object(i.b)("code",Object(a.a)({parentName:"pre"},{}),'.logo-gerencianetcharge{\n   background: transparent url("/img/gateway_logos/gerencianetcharge.png") no-repeat scroll 0% 0%;\n    background-size: contain;\n    width:135px;\n    height: 25px;\n    border: 0;\n    margin: 10px;\n}\n')),Object(i.b)("br",null),Object(i.b)("p",null,"The Gerencianet module files must have the following structure in Box Billing:"),Object(i.b)("pre",null,Object(i.b)("code",Object(a.a)({parentName:"pre"},{}),"/bb-library/Payment/Adapter/\n  |  gerencianet_lib/\n  |  gerencianetcharge.php\n")),Object(i.b)("br",null),Object(i.b)("h3",{id:"module-settings"},"Module settings"),Object(i.b)("p",null,Object(i.b)("img",Object(a.a)({parentName:"p"},{src:"/img/boxbilling.png",alt:"alt text",title:"Box Billing configura\xe7\xe3o"}))),Object(i.b)("p",null,"Within the Boxbilling admin panel, access the menu ",Object(i.b)("code",null,"Configuration > Payment Gateways"),". click to edit module settings ",Object(i.b)("code",null,"gerencianetcharge"),". The screen shown above will be displayed. Within the form, you must fill in the following fields:"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"1. Client_Id Produ\xe7\xe3o:")," It must be filled in with the ",Object(i.b)("code",null,"Client_Id")," of production from your Gerencianet account. This field is mandatory and can be found in the menu ",Object(i.b)("code",null,"API > Minhas Aplica\xe7\xf5es"),". Then select your created application as shown ",Object(i.b)("a",{href:"https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2020/07/30/matheus.rodrigues/001a47-b9e519bf-b76d-4178-b564-eb8d4981b203.png",target:"_blank"},"in this link"),";"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"2. Client_Secret Produ\xe7\xe3o:")," It must be filled in with the ",Object(i.b)("code",null,"Client_Secret")," of production from your Gerencianet account. This field is mandatory and can be found in the menu ",Object(i.b)("code",null,"API > Minhas Aplica\xe7\xf5es"),". Then select your created application as shown ",Object(i.b)("a",{href:"https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2020/07/30/matheus.rodrigues/a803ce-592ac502-6ead-44c4-bd75-fce1c1ed8637.png",target:"_blank"},"in this link"),";"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"3. Client_Id Desenvolvimento:")," It must be filled in with the ",Object(i.b)("code",null,"Client_Id")," of development from your Gerencianet account. This field is mandatory and can be found in the menu ",Object(i.b)("code",null,"API > Minhas Aplica\xe7\xf5es"),". EThen select your created application as shown ",Object(i.b)("a",{href:"https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2020/07/30/matheus.rodrigues/622255-9e257a75-4884-4e73-89f5-d7ec7b1f5b4c.png",target:"_blank"},"in this link"),";"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"4. Client_Secret Desenvolvimento:")," It must be filled in with the ",Object(i.b)("code",null,"Client_Secret")," of development from your Gerencianet account. This field is mandatory and can be found in the menu ",Object(i.b)("code",null,"API > Minhas Aplica\xe7\xf5es"),". Then select your created application as shown ",Object(i.b)("a",{href:"https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2020/07/30/matheus.rodrigues/680331-39fadf5b-6807-4ffa-a433-b2f656060984.png",target:"_blank"},"in this link"),";"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"5. Identificador da Conta:")," It must be filled in with the identifier of your Gerencianet account. This field is mandatory. Check where to find it on your platform (",Object(i.b)("a",{href:"https://s3.amazonaws.com/gerencianet-pub-prod-1/printscreen/2020/07/24/matheus.rodrigues/b66b15-d2201967-d646-4988-8e39-cffae37df203.png",target:"_blank"},"Identificador da Conta"),");"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"6. E-mail de cobran\xe7a - Gerencianet:")," If you are interested, enable the sending of billing emails from Gerencianet to the end customer;"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"7. Sandbox:")," If you are interested, enable the Gerencianet API test environment;"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"8. Moeda:")," Choose the option ",Object(i.b)("code",null,"R$ Real")," (it must be defined in your Boxbilling);"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"9. Enabled:")," Choose the option ",Object(i.b)("code",null,"Yes")," to activate the Gerencianet module;"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"10. Allow one time payments:")," Choose the option ",Object(i.b)("code",null,"Yes"),";"),Object(i.b)("p",null,Object(i.b)("strong",{parentName:"p"},"11. Allow subscription payments:")," Choose the option ",Object(i.b)("code",null,"No")," (the Gerencianet module does not support subscription transactions);"),Object(i.b)("p",null,"Finally, click in ",Object(i.b)("code",null,"UPDATE"),"."),Object(i.b)("div",{className:"admonition admonition-caution alert alert--warning"},Object(i.b)("div",Object(a.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(a.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(a.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"16",height:"16",viewBox:"0 0 16 16"}),Object(i.b)("path",Object(a.a)({parentName:"svg"},{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})))),"caution")),Object(i.b)("div",Object(a.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"It is important to note that ",Object(i.b)("strong",{parentName:"p"},"boletos generated in sandbox are not valid and cannot be paid"),', they have the typeable line "zero" and a watermark at the bottom stating that it is a test ticket.'),Object(i.b)("p",{parentName:"div"},Object(i.b)("strong",{parentName:"p"},'Payments for sandbox charges using credit card are dummy even if using a "real" card.'),' All card payments in this environment will have the payment confirmed automatically, but this is just a status change to "Paid" . This feature allows you to test the ',Object(i.b)("code",null,"paid")," status notification."),Object(i.b)("p",{parentName:"div"},Object(i.b)("strong",{parentName:"p"},"This means that all payments made in the sandbox are not real and, therefore, there is no financial charge.")),Object(i.b)("p",{parentName:"div"},"It is important to know that the words ",Object(i.b)("strong",{parentName:"p"},"Playground, Sandbox and Development Environment"),", in the Gerencianet context, are synonymous. They refer to the test site we offer where you can freely test your API integration."))),Object(i.b)("br",null),Object(i.b)("hr",null),Object(i.b)("h2",{id:"3-common-integration-errors"},"3. Common Integration Errors"),Object(i.b)("p",null,'Even if none of these validation errors are returned, the Gerencianet API may return errors  referring to the generation of the charge. To interpret the API returns and, of course, correct possible data validation errors or similar ones, go to "',Object(i.b)("a",Object(a.a)({parentName:"p"},{href:"../../docs/VisaoGeral/InterpretandoErros"}),"page"),'".')))}s.isMDXComponent=!0},250:function(e,t,n){"use strict";n.d(t,"a",(function(){return d})),n.d(t,"b",(function(){return m}));var a=n(0),o=n.n(a);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function c(e,t){if(null==e)return{};var n,a,o=function(e,t){if(null==e)return{};var n,a,o={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var b=o.a.createContext({}),s=function(e){var t=o.a.useContext(b),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return o.a.createElement(b.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},u=o.a.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,r=e.parentName,b=c(e,["components","mdxType","originalType","parentName"]),d=s(n),u=a,m=d["".concat(r,".").concat(u)]||d[u]||p[u]||i;return n?o.a.createElement(m,l(l({ref:t},b),{},{components:n})):o.a.createElement(m,l({ref:t},b))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,r=new Array(i);r[0]=u;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:a,r[1]=l;for(var b=2;b<i;b++)r[b]=n[b];return o.a.createElement.apply(null,r)}return o.a.createElement.apply(null,n)}u.displayName="MDXCreateElement"},251:function(e,t,n){"use strict";var a=n(0),o=n(35);t.a=function(){return Object(a.useContext)(o.a)}},252:function(e,t,n){"use strict";n.d(t,"a",(function(){return i}));var a=n(251),o=n(253);function i(e,{forcePrependBaseUrl:t=!1,absolute:n=!1}={}){const{siteConfig:{baseUrl:i="/",url:r}={}}=Object(a.a)();if(!e)return e;if(t)return i+e;if(!Object(o.a)(e))return e;const l=i+e.replace(/^\//,"");return n?r+l:l}},253:function(e,t,n){"use strict";function a(e){return!1===/^(https?:|\/\/|mailto:|tel:)/.test(e)}n.d(t,"a",(function(){return a}))}}]);