{"id":8039,"date":"2023-08-14T13:47:40","date_gmt":"2023-08-14T20:47:40","guid":{"rendered":"https:\/\/membermouse.com\/?post_type=ht_kb&amp;p=8039"},"modified":"2023-08-14T13:47:40","modified_gmt":"2023-08-14T20:47:40","slug":"introducao-a-api-do-membermouse","status":"publish","type":"ht_kb","link":"https:\/\/membermouse.com\/pt\/documentos-3-2\/introducao-a-api-do-membermouse\/","title":{"rendered":"Primeiros passos com a API MemberMouse"},"content":{"rendered":"<h5 class=\"wp-block-heading\">URL e credenciais da API<\/h5>\n\n\n\n<p>A primeira coisa de que voc\u00ea precisa para usar a API do MemberMouse \u00e9 o URL e as credenciais da API. Na se\u00e7\u00e3o\u00a0<em>MembroMouse<\/em>\u00a0menu ir para\u00a0<em>Ferramentas do desenvolvedor<\/em>\u00a0e clique no \u00edcone\u00a0<em>Guia Credenciais da API<\/em>. Nesta p\u00e1gina, voc\u00ea pode\u00a0<a href=\"https:\/\/membermouse.com\/pt\/documentos-3-2\/visao-geral-das-credenciais-da-api\/\">veja seu URL de API e crie e gerencie credenciais de API<\/a>.<br><br><img decoding=\"async\" class=\"wp-image-9607\" style=\"width: 600px;\" src=\"https:\/\/storage.googleapis.com\/wpgcbucket\/wp\/2023\/08\/1a3347e3-yo8k2j_77qatdr1uudykxxjbbsee4gw6ta.png\" alt=\"\"><\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h5 class=\"wp-block-heading\">Execu\u00e7\u00e3o de uma chamada de API<\/h5>\n\n\n\n<p>Para fazer uma chamada de API, voc\u00ea precisar\u00e1 fazer uma solicita\u00e7\u00e3o ao URL da chamada de API e passar os par\u00e2metros de entrada apropriados. O URL da chamada de API e os par\u00e2metros de entrada variam de acordo com a chamada de API que est\u00e1 sendo feita. Consulte este artigo para obter informa\u00e7\u00f5es sobre&nbsp;<a href=\"https:\/\/membermouse.com\/pt\/documentos-3-2\/documentacao-da-api\/\">uma lista das chamadas de API no MemberMouse<\/a>&nbsp;e clique em uma chamada de API para visualizar o URL associado e os par\u00e2metros de entrada.<\/p>\n\n\n\n<div style=\"height:5px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p><a href=\"https:\/\/drive.google.com\/file\/d\/1STcKWD6bl3hFqatNVHepIcVJeqAX-h1b\/view?usp=drive_link\"><strong><em>Fa\u00e7a o download do c\u00f3digo de amostra para PHP<\/em><\/strong><\/a><\/p>\n\n\n\n<div style=\"height:5px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Abaixo est\u00e1 um exemplo de chamada de API para criar um novo membro usando o\u00a0<a href=\"https:\/\/membermouse.com\/pt\/documentos-3-2\/chamada-de-api-de-createmember\/\">Chamada da API createMember<\/a>. <\/p>\n\n\n\n<p>Primeiro, estamos definindo os par\u00e2metros de entrada como uma cadeia de pares nome\/valor separados por um\u00a0<code>&<\/code>\u00a0e armazenados no\u00a0<code>$inputParams<\/code>\u00a0vari\u00e1vel. <\/p>\n\n\n\n<p>Em seguida, estamos definindo o URL da chamada de API e inicializando um\u00a0<a rel=\"noreferrer noopener\" href=\"http:\/\/php.net\/manual\/en\/book.curl.php\" target=\"_blank\">inst\u00e2ncia cURL<\/a>. <\/p>\n\n\n\n<p>Por fim, estamos executando a inst\u00e2ncia cURL, decodificando o resultado da chamada e armazenando-o em um arquivo\u00a0<code>$data<\/code>\u00a0e, em seguida, enviando-a para a tela. <\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<pre class=\"wp-block-code\"><code>$inputParams = &quot;apikey={Sua_API_Key}&amp;amp;apisecret={Sua_API_Secret}&amp;amp;&quot;;\n$inputParams .= &quot;first_name=Tom&amp;amp;&quot;;\n$inputParams .= &quot;last_name=Smith&amp;amp;&quot;; $inputParams .= &quot;last_name=Smith&amp;amp;&quot;;\n$inputParams .= &quot;email=tom.smith@gmail.com&amp;amp;&quot;;\n$inputParams .= &quot;phone=(212) 555-7864&amp;amp;&quot;;\n$inputParams .= &quot;membership_level_id=2&amp;amp;&quot;;\n\n$apiCallUrl = &quot;https:\/\/{Your_API_URL}?q=\/createMember&quot;;\n$ch = curl_init($apiCallUrl);\n\ncurl_setopt($ch, CURLOPT_POST, 1);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $inputParams);\ncurl_setopt($ch, CURLOPT_HEADER, 0);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\n$result = curl_exec($ch);\ncurl_close($ch);\n\necho &quot;Resposta RAW: &quot;.$result.&quot;&lt;br \/&gt;&quot;;\n$data = json_decode($result);\necho &quot;&lt;pre&gt;&quot;;\nvar_dump($data-&amp;gt;response_data);\necho &quot;&lt;\/pre&gt;&quot;; <\/code><\/pre>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Para modificar isso para diferentes chamadas de API, ser\u00e1 necess\u00e1rio alterar o URL da chamada de API e os par\u00e2metros de entrada de acordo com a documenta\u00e7\u00e3o da chamada de API que voc\u00ea est\u00e1 fazendo.<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h5 class=\"wp-block-heading\">Mod_security Bloqueio de solicita\u00e7\u00f5es<\/h5>\n\n\n\n<p>Em alguns servidores, voc\u00ea pode descobrir que as chamadas de API est\u00e3o sendo rejeitadas pelo servidor. Isso geralmente est\u00e1 relacionado a configura\u00e7\u00f5es de seguran\u00e7a no servidor, como mod_security. Para contornar esse problema, voc\u00ea pode tentar passar cabe\u00e7alhos adicionais para a solicita\u00e7\u00e3o cURL para simular que ela vem de um navegador real, como segue: <\/p>\n\n\n\n<div style=\"height:5px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<pre class=\"wp-block-code\"><code>$headers = array(\n'Referrer: http:\/\/yourdomain.com',\n'User-Agent: Mozilla\/5.0 (X11; Ubuntu; Linux i686; rv:28.0) Gecko\/20100101 Firefox\/28.0'\n);\ncurl_setopt($ch,CURLOPT_HTTPHEADER,$headers); <\/code><\/pre>\n\n\n\n<div style=\"height:5px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>\u00c9 claro que voc\u00ea deve substituir http:\/\/yourdomain.com pelo seu dom\u00ednio real.<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h5 class=\"wp-block-heading\">Acesso ao c\u00f3digo de resposta<\/h5>\n\n\n\n<p>Na solicita\u00e7\u00e3o de exemplo acima, o\u00a0<code>json_decode()<\/code>\u00a0\u00e9 usado para analisar o objeto de resultado da chamada de API e armazen\u00e1-lo no\u00a0<code>$data<\/code>\u00a0vari\u00e1vel. Nesse ponto, o c\u00f3digo de resposta pode ser acessado da seguinte forma:<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<pre class=\"wp-block-code\"><code>$data-&gt;response_code;<\/code><\/pre>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Veja este artigo para&nbsp;<a href=\"https:\/\/membermouse.com\/pt\/documentos-3-2\/documentacao-da-api\/\">uma lista das chamadas de API no MemberMouse<\/a>&nbsp;e clique em uma chamada de API para visualizar os c\u00f3digos de resposta associados.<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h5 class=\"wp-block-heading\">Acesso aos dados de resposta<\/h5>\n\n\n\n<p>Na solicita\u00e7\u00e3o de exemplo acima, o\u00a0<code>json_decode()<\/code>\u00a0\u00e9 usado para analisar o objeto de resultado da chamada de API e armazen\u00e1-lo no\u00a0<code>$data<\/code>\u00a0vari\u00e1vel. Nesse ponto, os dados de resposta podem ser acessados da seguinte forma:<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<pre class=\"wp-block-code\"><code>$data-&gt;response_data-&gt;username;\n$data-&gt;response_data-&gt;password (senha);\n$data-&gt;response_data-&gt;email;<\/code><\/pre>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Onde\u00a0<code>nome de usu\u00e1rio<\/code>,\u00a0<code>senha<\/code>\u00a0e\u00a0<code>e-mail<\/code>\u00a0s\u00e3o par\u00e2metros v\u00e1lidos no objeto de dados de resposta. A lista de par\u00e2metros v\u00e1lidos varia de acordo com a chamada de API feita. Consulte este artigo para obter informa\u00e7\u00f5es sobre\u00a0<a href=\"https:\/\/membermouse.com\/pt\/documentos-3-2\/documentacao-da-api\/\">uma lista das chamadas de API no MemberMouse<\/a>\u00a0e clique em uma chamada de API para visualizar os dados de resposta associados.<\/p>\n\n\n\n<p><a href=\"https:\/\/drive.google.com\/file\/d\/1ZqvifvKNobr7Bacqt-EC4tBfiKIeugJh\/view?usp=drive_link\" target=\"_blank\" rel=\"noreferrer noopener\"><strong><em>Baixe o c\u00f3digo de amostra para Python<\/em><\/strong><\/a><\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>","protected":false},"excerpt":{"rendered":"<p>URL e credenciais da API A primeira coisa de que voc\u00ea precisa para usar a API do MemberMouse \u00e9 o URL e as credenciais da API. No menu do MemberMouse, v\u00e1 para Ferramentas de desenvolvedor e clique em API...<\/p>","protected":false},"author":21411,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_acf_changed":false,"om_disable_all_campaigns":false,"_strive_editorial_status":"not-started","_strive_copy_of":0,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"ht-kb-category":[183],"ht-kb-tag":[],"class_list":["post-8039","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-mm-api"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/ht-kb\/8039","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/users\/21411"}],"replies":[{"embeddable":true,"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/comments?post=8039"}],"version-history":[{"count":0,"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/ht-kb\/8039\/revisions"}],"wp:attachment":[{"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/media?parent=8039"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/ht-kb-category?post=8039"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/membermouse.com\/pt\/wp-json\/wp\/v2\/ht-kb-tag?post=8039"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}