Sign in to your Google Cloud account. If you're new to
Google Cloud,
create an account to evaluate how our products perform in
real-world scenarios. New customers also get $300 in free credits to
run, test, and deploy workloads.
Instale a CLI do Google Cloud.
Após a instalação,
inicialize a Google Cloud CLI executando o seguinte comando:
A Web Risk fornece duas APIs diferentes que podem ser integradas. Essas APIs são a API Lookup e a API Update. Ambas as APIs fornecem as mesmas informações. Ou seja, se um URL foi identificado como malicioso. A mais fácil de usar é a API Lookup. Usando a API Lookup, você consultará a Web Risk para cada URL que você quer verificar.
A API Update é mais complexa, mas tem algumas propriedades desejáveis. Usando a API Update, você manterá um banco de dados local. Esse banco de dados pode ser verificado para ver se um URL é malicioso. Esse banco de dados atua como um filtro de floração. Ou seja, pode haver falsos positivos (um URL é identificado como malicioso, mas não deve ser), mas não deve haver nenhum falso negativo (um URL é identificado como não malicioso, mas é). Por isso, os servidores da Web Risk raramente são contatados e só são contatados para confirmar correspondências e para desambiguar falsos positivos. Na maioria dos casos, ao verificar um URL usando a API Update, você não precisa entrar em contato com os servidores da Web Risk. Espera-se que você entre em contato com os servidores da Web Risk somente ao atualizar o banco de dados local e ao confirmar um URL.
Em resumo, use a API Lookup se quiser configurar de maneira rápida e fácil.
Use a API Update se precisar de uma verificação de URL de latência mais baixa.
Como escolher os recursos certos para o cliente
Se você optou por usar a API Update, talvez não seja necessário implementar toda a especificação. Há alguns recursos projetados para clientes amplamente distribuídos (como navegadores da Web) que são otimizações em excesso em muitos casos corporativos.
Alguns recursos podem ser ignorados para facilitar a integração.
Estas são as soluções de integração da Web Risk em ordem de complexidade
Usar a API LookUp
Cliente da API Update básica
Cliente da API Update usando diferenças
Ciente da API Update usando diferenças com compactação RICE
Como usar a API Lookup
O uso da API Lookup tem a menor complexidade. Sempre que houver um URL potencialmente suspeito, basta chamar a API Lookup com o URL para ver um veredito.
A canonicidade e a formatação do URL são tratadas pelo servidor da Web Risk. Essa solução deve ser válida para a maioria dos clientes, a menos que a latência média exceda os requisitos.
Cliente da API Update básica
A API Update exige a complexidade adicional do gerenciamento de um banco de dados local e de URLs canônicos antes das consultas.
Em uma integração de cliente típica com a Web Risk, um cliente aplicará diferenças de banco de dados para permanecer atualizado. A lógica do aplicativo de diferenças pode levar algum tempo para ser implementada corretamente. Portanto, nos casos mais simples, recomendamos que os clientes ignorem as diferenças e solicitem um novo banco de dados completo da Web Risk a cada ciclo. Esse banco de dados ainda será armazenado na memória para consultas eficientes. A solicitação de uma redefinição completa do banco de dados é feita deixando o campo versionToken vazio na solicitação threatLists.computeDiff.
Essa solução deve ser válida para clientes, a menos que a latência de sincronização do banco de dados ou da largura de banda exceda os requisitos.
Usar a API Update e solicitar atualizações diferentes
Essa solução tem a complexidade adicional de aplicar a lógica de diferenças ao banco de dados local. Para mais informações, consulte Diferenças de banco de dados. O uso de diferenças reduzirá a largura de banda à custa da complexidade, em comparação com a solicitação de um novo banco de dados a cada ciclo. Uma atualização completa do banco de dados pode estar na ordem de alguns megabytes.
Essa solução deve ser suficiente para a maioria dos clientes empresariais.
Usar a API Update e solicitar atualizações de diferenças codificadas em RICE
Essa solução é a integração de cliente mais eficiente possível. A codificação RICE compacta tamanhos DIFF e reduz ainda mais a largura de banda de atualização. Esta solução deve ser usada pelos clientes com maior largura de banda. Um exemplo em que isso pode ser relevante é se as consultas da Web Risk estiverem incorporadas em um aplicativo para telefone. Os usuários desse aplicativo com certeza gostariam de uma solução de largura de banda menor se precisassem atualizar o banco de dados por dados de telefone.
Para mais informações, consulte Compactação.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-17 UTC."],[],[],null,["# Detect malicious URLs with Web Risk\n===================================\n\nBefore you begin\n----------------\n\n- Create a Google Cloud project. [Learn how to create a Google Cloud project](/resource-manager/docs/creating-managing-projects#creating_a_project).\n\n-\n\n\n [Verify that billing is enabled for your Google Cloud project](/billing/docs/how-to/verify-billing-enabled#confirm_billing_is_enabled_on_a_project).\n\n \u003cbr /\u003e\n\nSet up authentication and enable the Web Risk API\n-------------------------------------------------\n\nSign in to your Google Cloud account. If you're new to Google Cloud, [create an account](https://console.cloud.google.com/freetrial) to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.\n\n\n[Install](/sdk/docs/install) the Google Cloud CLI.\n\nAfter installation,\n[initialize](/sdk/docs/initializing) the Google Cloud CLI by running the following command:\n\n```bash\ngcloud init\n```\n\n\nIf you're using an external identity provider (IdP), you must first\n[sign in to the gcloud CLI with your federated identity](/iam/docs/workforce-log-in-gcloud).\n\n[Create or select a Google Cloud project](https://cloud.google.com/resource-manager/docs/creating-managing-projects).\n| **Note**: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.\n\n- Create a Google Cloud project:\n\n ```\n gcloud projects create PROJECT_ID\n ```\n\n Replace \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e with a name for the Google Cloud project you are creating.\n- Select the Google Cloud project that you created:\n\n ```\n gcloud config set project PROJECT_ID\n ```\n\n Replace \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e with your Google Cloud project name.\n\n\n[Verify that billing is enabled for your Google Cloud project](/billing/docs/how-to/verify-billing-enabled#confirm_billing_is_enabled_on_a_project).\n\n\nEnable the Web Risk API:\n\n\n```bash\ngcloud services enable webrisk.googleapis.com\n``` \n\n[Install](/sdk/docs/install) the Google Cloud CLI.\n\nAfter installation,\n[initialize](/sdk/docs/initializing) the Google Cloud CLI by running the following command:\n\n```bash\ngcloud init\n```\n\n\nIf you're using an external identity provider (IdP), you must first\n[sign in to the gcloud CLI with your federated identity](/iam/docs/workforce-log-in-gcloud).\n\n[Create or select a Google Cloud project](https://cloud.google.com/resource-manager/docs/creating-managing-projects).\n| **Note**: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.\n\n- Create a Google Cloud project:\n\n ```\n gcloud projects create PROJECT_ID\n ```\n\n Replace \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e with a name for the Google Cloud project you are creating.\n- Select the Google Cloud project that you created:\n\n ```\n gcloud config set project PROJECT_ID\n ```\n\n Replace \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e with your Google Cloud project name.\n\n\n[Verify that billing is enabled for your Google Cloud project](/billing/docs/how-to/verify-billing-enabled#confirm_billing_is_enabled_on_a_project).\n\n\nEnable the Web Risk API:\n\n\n```bash\ngcloud services enable webrisk.googleapis.com\n```\n\n\u003cbr /\u003e\n\nUsing the APIs\n--------------\n\nWhen you use the Web Risk APIs, make sure you're familiar with Web Risk's [Service Level Agreement](/web-risk/sla) and [usage limits](/web-risk/quotas).\n\nTo start using Web Risk, see these topics:\n\n- [Using the Lookup API](/web-risk/docs/lookup-api)\n- [Using the Update API](/web-risk/docs/update-api)\n\nWhich API is right for me? Lookup or Update?\n--------------------------------------------\n\nWeb Risk provides two different APIs that you may integrate with. These\nAPIs are the [Lookup API](/web-risk/docs/lookup-api) and the [Update API](/web-risk/docs/update-api). Both of\nthese APIs provide the same information. That is, whether a URL has been\nidentified as malicious. The easiest to use is the Lookup API. Using the Lookup\nAPI, you will query Web Risk for every URL you wish to check.\n\nThe Update API is more complex but has some desirable properties. Using the\nUpdate API, you will maintain a local database. This database may be checked\nto see if a URL is malicious. This database acts as a bloom filter. That is,\nthere may be false positives (a URL is identified as malicious but isn't) but\nthere should not be any false negatives (a URL is identified as not malicious,\nbut is). Because of this, the Web Risk servers are rarely contacted, and are\nonly contacted to confirm matches and disambiguate false positives. In most\ncases, when checking a URL using the Update API you won't need to contact the\nWeb Risk servers at all. You are expected to contact Web Risk servers only when\nupdating the local database and when confirming a URL is harmful.\n\nIn summary, use the Lookup API if you want to get set up quickly and easily.\nUse the Update API if you need lower latency URL checking.\n\nChoosing the Right Client Features\n----------------------------------\n\nIf you chose to use the Update API, you may not need to implement the entire\nspecification. There are some features that were designed for widely distributed\nclients (like web browsers) that are over-optimizations in many enterprise\ncases.\n\nThere are some features that may be ignored for easier integration.\n\nHere are the Web Risk integration solutions in order of complexity\n\n1. Use the LookUp API\n2. Basic Update API client\n3. Update API client using diffs\n4. Update API client using RICE compressed diffs\n\n### Using the Lookup API\n\nUsing the Lookup API has the lowest complexity. Whenever there is a potentially\nsuspicious URL, simply call the Lookup API with the URL to see a verdict.\nCanonicalization and formatting the URL is handled by the Web Risk\nserver. This solution should be valid for most clients unless average latency\nexceeds requirements.\n\n### Basic Update API client\n\nThe Update API requires the additional complexity of managing a local database\nand canonicalized URLs before queries.\n\nIn a typical client integration with Web Risk, a client will apply database\ndiffs to remain up-to-date. The diff application logic may take some time to\nimplement correctly, so in the simplest cases we recommend clients ignore diffs\nand request a full new database from Web Risk every cycle. This database will\nstill be stored in memory for efficient querying. Requesting a full database\nreset is done by leaving the `versionToken` field empty in the\n[`threatLists.computeDiff` request](/web-risk/docs/update-api#http_get_request).\nThis solution should be valid for clients unless bandwidth or database\nsynchronization latency exceeds requirements.\n\n### Use the Update API and request diff updates\n\nThis solution has the added complexity of applying the diff logic to the local\ndatabase. For more information, see\n[Database Diffs](/web-risk/docs/local-databases#full-updates). Using diffs will reduce\nbandwidth at the expense of complexity, compared to requesting a new database\neach cycle. A full database update may be on the order of a few megabytes.\nThis solution should be sufficient for most enterprise clients.\n\n### Use the Update API and request RICE encoded diff updates\n\nThis solution is the most efficient client integration possible. RICE encoding\ncompresses DIFF sizes and further reduces update bandwidth. This solution is\nintended to be used by the most bandwidth constrained customers. An example\nwhere this may be relevant is if Web Risk queries are built into a phone App.\nThe users of such an app would surely appreciate a lower bandwidth solution if\nthey needed to update the database over phone data.\nFor more information, see [Compression](/web-risk/docs/compression)."]]
