{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Autorização com mTLS","type":"basic","slug":"autorizacao-api-mtls","excerpt":"Esta página descreve os detalhes da autorização para  API Pix e API Pagamentos que contém como diferencial a utilização do mTLS","body":"## Certificado P12\n\nTodas as requisições para a <code>API Pix</code> devem conter um certificado de segurança que será fornecido pela Gerencianet dentro da sua conta, no formato <code>PFX(.p12)</code>. \nO Auth2  fornece um mecanismo de autorização chamado de mutual Transport Layer Security(mTLS) por meio do certificado emitido em sua conta Gerencianet, tal método acrescenta mais um nível de segurança às requisições trafegadas entre sua aplicação e a API Gerencianet. Essa exigência está descrita na íntegra no <a href=\"https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados\" target=\"_blank\" alt=\"manual de segurança do pix\">manual de segurança do PIX</a>.\n\n### Gerando um certificado P12\nPara gerar o seu certificado, basta seguir os passos abaixo:\n\n1. Acesse o item \"API\" no menu superior da conta Gerencianet;\n2. No menu à esquerda, clique em \"Meus Certificados\";\n3. Na nova janela selecione o ambiente ao qual pertencerá o certificado (Produção ou Homologação)\n4. Clique em \"Novo Certificado\" (botão laranja);\n5. Atribua uma descrição ao certificado para identificá-lo no futuro;\n6. Confirme a criação do certificado;\n7. Por fim, baixe o certificado.\n\n## Autorização de acesso para aplicação\n\nA API da Gerencianet é <a href=\"http://www.restapitutorial.com/\" target=\"_blank\" title=\"[link externo]\">RESTful</a>, as requisições/respostas são em JSON e utilizamos o <a href=\"http://oauth.net/2/\" target=\"_blank\">OAuth2</a> como framework de autorização à API. Todas as solicitações de OAuth2 devem utilizar o seu respectivo <em>endpoint</em> base:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"URL\\\": {\\n    \\\"sandbox\\\": \\\"https://api-pix.gerencianet.com.br\\\"\\n  }\",\n      \"language\": \"json\",\n      \"name\": \"API Pix-Produção\"\n    },\n    {\n      \"code\": \"\\\"URL\\\": {\\n    \\\"sandbox\\\": \\\"https://api-pix-h.gerencianet.com.br\\\"\\n  }\",\n      \"language\": \"json\",\n      \"name\": \"API Pix-Homologação\"\n    }\n  ]\n}\n[/block]\n## Endpoint: Authorize\n\nA API da Gerencianet é compatível com o protocolo <a href=\"http://oauth.net/2/\" target=\"_blank\">OAuth 2.0</a> para autorizar acesso à API. As requisições são autenticadas usando <a href=\"https://en.wikipedia.org/wiki/Basic_access_authentication\" target=\"_blank\" title=\"Link Externo\">HTTP Basic Auth</a>.\n\nO objetivo do protocolo OAuth2 é a troca de uma cadeia de tokens entre o *Cliente* e *Server Resource*. Esse token é usado para autenticar todas as chamadas a API usando *Authorization* no cabeçalho do HTTP.\n\nO <em>endpoint</em> base para autenticação é representado abaixo:</p>\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"authorize\\\": {\\n      \\\"route\\\": \\\"/oauth/token\\\",\\n      \\\"method\\\": \\\"post\\\"\",\n      \"language\": \"json\",\n      \"name\": \"Endpoint: Authorize\"\n    }\n  ]\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61265f3a7e43cb003fc1f466","createdAt":"2021-08-25T15:18:18.895Z","user":"5e8b36bc27ee9b00181b36bf","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Autenticação e Endpoints","slug":"endpoints","order":22,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba910078783430","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6","__v":0,"createdAt":"2016-07-01T14:39:59.801Z"},"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","61473375119247002a9c14d7"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":3,"forked_from":"575aeffae12cf20e002f306f"},"project":"575aeffae12cf20e002f306c","__v":0,"parentDoc":null}

Autorização com mTLS

Esta página descreve os detalhes da autorização para API Pix e API Pagamentos que contém como diferencial a utilização do mTLS

## Certificado P12 Todas as requisições para a <code>API Pix</code> devem conter um certificado de segurança que será fornecido pela Gerencianet dentro da sua conta, no formato <code>PFX(.p12)</code>. O Auth2 fornece um mecanismo de autorização chamado de mutual Transport Layer Security(mTLS) por meio do certificado emitido em sua conta Gerencianet, tal método acrescenta mais um nível de segurança às requisições trafegadas entre sua aplicação e a API Gerencianet. Essa exigência está descrita na íntegra no <a href="https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados" target="_blank" alt="manual de segurança do pix">manual de segurança do PIX</a>. ### Gerando um certificado P12 Para gerar o seu certificado, basta seguir os passos abaixo: 1. Acesse o item "API" no menu superior da conta Gerencianet; 2. No menu à esquerda, clique em "Meus Certificados"; 3. Na nova janela selecione o ambiente ao qual pertencerá o certificado (Produção ou Homologação) 4. Clique em "Novo Certificado" (botão laranja); 5. Atribua uma descrição ao certificado para identificá-lo no futuro; 6. Confirme a criação do certificado; 7. Por fim, baixe o certificado. ## Autorização de acesso para aplicação A API da Gerencianet é <a href="http://www.restapitutorial.com/" target="_blank" title="[link externo]">RESTful</a>, as requisições/respostas são em JSON e utilizamos o <a href="http://oauth.net/2/" target="_blank">OAuth2</a> como framework de autorização à API. Todas as solicitações de OAuth2 devem utilizar o seu respectivo <em>endpoint</em> base: [block:code] { "codes": [ { "code": "\"URL\": {\n \"sandbox\": \"https://api-pix.gerencianet.com.br\"\n }", "language": "json", "name": "API Pix-Produção" }, { "code": "\"URL\": {\n \"sandbox\": \"https://api-pix-h.gerencianet.com.br\"\n }", "language": "json", "name": "API Pix-Homologação" } ] } [/block] ## Endpoint: Authorize A API da Gerencianet é compatível com o protocolo <a href="http://oauth.net/2/" target="_blank">OAuth 2.0</a> para autorizar acesso à API. As requisições são autenticadas usando <a href="https://en.wikipedia.org/wiki/Basic_access_authentication" target="_blank" title="Link Externo">HTTP Basic Auth</a>. O objetivo do protocolo OAuth2 é a troca de uma cadeia de tokens entre o *Cliente* e *Server Resource*. Esse token é usado para autenticar todas as chamadas a API usando *Authorization* no cabeçalho do HTTP. O <em>endpoint</em> base para autenticação é representado abaixo:</p> [block:code] { "codes": [ { "code": "\"authorize\": {\n \"route\": \"/oauth/token\",\n \"method\": \"post\"", "language": "json", "name": "Endpoint: Authorize" } ] } [/block]