{"id":17869,"date":"2017-02-10T14:05:36","date_gmt":"2017-02-10T12:05:36","guid":{"rendered":"https:\/\/blog.basetis.com\/article_basic\/api-keys-en-proyectos-android-open-source\/"},"modified":"2024-03-12T13:42:28","modified_gmt":"2024-03-12T11:42:28","slug":"api-keys-en-proyectos-android-open-source","status":"publish","type":"article_basic","link":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/","title":{"rendered":"API keys en proyectos Android open source"},"content":{"rendered":"

<\/p>\n

En nuestros proyectos es habitual usar APIs de terceros que nos permiten a\u00f1adir funcionalidades sin tener que desarrollarlas nosotros mismos.<\/p>\n

Muchas APIs requieren el uso de keys que habremos obtenido al registrarnos como developers <\/em>en alg\u00fan servicio (Twitter, Facebook, Instagram, etc\u2026) y solemos almacenar dichas keys en la t\u00edpica utils.class o apiKeys.class…<\/p>\n

Cuando subimos nuestro c\u00f3digo a un repositorio p\u00fablico cambiamos las keys de estos archivos por el famoso <\/strong>\u201cYOUR_POCKET_APIKEY_HERE\u201d, y como son clases que en alg\u00fan momento vamos modificando, no las ponemos en ignore<\/em>, por lo que cada vez que comiteamos <\/em>tenemos que tenerlo presente.
\n <\/p>\n

Un d\u00eda, por descuido, subir\u00e1s tus keys, y lo sabes\u2026<\/h2>\n

\u00bfC\u00f3mo evitarlo? Pues en un proyecto open source<\/em> vi el m\u00e9todo que os explico a continuaci\u00f3n y me gust\u00f3 mucho. Ver\u00e9is que es muy f\u00e1cil de implementar, vamos all\u00e1…<\/p>\n

Pongamos que nuestra app de Android tiene dos keys, CUSTOMER_KEY y CUSTOMER_SECRET, almacenadas en una utils.class like this<\/em>:<\/p>\n

 <\/p>\n

\"\"<\/span><\/span><\/span><\/p>\n

\"2.jpg\"<\/span><\/span><\/span><\/p>\n

 <\/p>\n

La idea es tener un archivo de texto en el proyecto, que en el repositorio marcaremos como ignore<\/em>, y configuraremos Gradle para que compruebe la existencia de este archivo. Si existe recoger\u00e1 las keys correspondientes y si no crear\u00e1 unas que definamos nosotros.<\/p>\n

Primero configuraremos Gradle (build.gradle \u201cModule app\u201d). A\u00f1adiendo en Android -> defaultConfig el siguiente c\u00f3digo:<\/p>\n

 <\/p>\n

\"\"<\/span><\/span><\/span><\/p>\n

\nsecrets.properties ser\u00e1 el archivo de texto que contendr\u00e1 las keys y se encontrar\u00e1 en el root <\/em>del proyecto.<\/p>\n

Con if <\/em>(secretsExists.exists()) comprobamos si existe y si es as\u00ed a\u00f1adimos tantos campos como keys tengamos en el archivo, en este caso CONSUMER_KEY y CONSUMER_SECRET de tipo String.<\/p>\n

Si el archivo secrets.properties no existe crearemos dos campos con los mismos nombres pero con valores inventados.<\/p>\n

Siguiente paso ser\u00e1 modificar nuestra utils.class para que recoja de buildconfig las propiedades creadas.
\n <\/p>\n

\"\"<\/span><\/span><\/span><\/p>\n

\nSi ahora ejecutamos nuestra app, y al no existir a\u00fan el archivo que contiene las keys, ver\u00edamos lo siguiente:<\/p>\n

 <\/p>\n

\"\"<\/span><\/span><\/span><\/p>\n

 <\/p>\n

Por \u00faltimo a\u00f1adimos nuestro secrets.properties en el root del proyecto
\n <\/p>\n

\"\"<\/span><\/span><\/span><\/p>\n

\ny una vez creado el archivo si volvemos a ejecutar nuestra app\u2026<\/p>\n

 <\/p>\n

\"\"<\/span><\/span><\/span><\/p>\n

 <\/p>\n

Recordar marcar como ignore <\/em>en nuestro repositorio este archivo. Cuando alguien se descargue nuestro proyecto deber\u00e1 crearse su propio secrets.properties, lo indicaremos en el read.me del repositorio indicando el formato que ha de tener.
\n <\/p>\n

Easy \ud83d\ude42<\/h2>\n
Foto de cabecera: Intel Free Press \/ Flickr<\/a><\/h5>\n","protected":false},"excerpt":{"rendered":"

En nuestros proyectos es habitual usar APIs de terceros que nos permiten a\u00f1adir funcionalidades sin tener que desarrollarlas nosotros mismos. Muchas APIs requieren el uso de keys que habremos obtenido al registrarnos como developers en alg\u00fan servicio (Twitter, Facebook, Instagram, etc\u2026) y solemos almacenar dichas keys en la t\u00edpica utils.class o apiKeys.class… Cuando subimos nuestro c\u00f3digo […]<\/p>\n","protected":false},"author":866,"featured_media":1313,"parent":0,"menu_order":0,"comment_status":"open","ping_status":"","template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[1562],"tags":[1593,1637,1813,1644],"etiquetes":[],"categorias":[],"class_list":["post-17869","article_basic","type-article_basic","status-publish","format-standard","has-post-thumbnail","hentry","category-tecnologia","tag-android","tag-medalla-blogger","tag-open","tag-programacion"],"acf":[],"yoast_head":"\nAPI keys en proyectos Android open source - Basetis<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/\" \/>\n<meta property=\"og:locale\" content=\"es_ES\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API keys en proyectos Android open source - Basetis\" \/>\n<meta property=\"og:description\" content=\"En nuestros proyectos es habitual usar APIs de terceros que nos permiten a\u00f1adir funcionalidades sin tener que desarrollarlas nosotros mismos. Muchas APIs requieren el uso de keys que habremos obtenido al registrarnos como developers en alg\u00fan servicio (Twitter, Facebook, Instagram, etc\u2026) y solemos almacenar dichas keys en la t\u00edpica utils.class o apiKeys.class… Cuando subimos nuestro c\u00f3digo […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/\" \/>\n<meta property=\"og:site_name\" content=\"Basetis\" \/>\n<meta property=\"article:modified_time\" content=\"2024-03-12T11:42:28+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/blog.basetis.com\/wp-content\/uploads\/2018\/10\/Keys_on_Keyboard.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1\" \/>\n\t<meta property=\"og:image:height\" content=\"1\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Tiempo de lectura\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/es\\\/article_basic\\\/api-keys-en-proyectos-android-open-source\\\/\",\"url\":\"https:\\\/\\\/blog.basetis.com\\\/es\\\/article_basic\\\/api-keys-en-proyectos-android-open-source\\\/\",\"name\":\"API keys en proyectos Android open source - Basetis\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/es\\\/article_basic\\\/api-keys-en-proyectos-android-open-source\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/es\\\/article_basic\\\/api-keys-en-proyectos-android-open-source\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/blog.basetis.com\\\/wp-content\\\/uploads\\\/2018\\\/10\\\/Keys_on_Keyboard.jpg\",\"datePublished\":\"2017-02-10T12:05:36+00:00\",\"dateModified\":\"2024-03-12T11:42:28+00:00\",\"inLanguage\":\"es\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/blog.basetis.com\\\/es\\\/article_basic\\\/api-keys-en-proyectos-android-open-source\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"es\",\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/es\\\/article_basic\\\/api-keys-en-proyectos-android-open-source\\\/#primaryimage\",\"url\":\"https:\\\/\\\/blog.basetis.com\\\/wp-content\\\/uploads\\\/2018\\\/10\\\/Keys_on_Keyboard.jpg\",\"contentUrl\":\"https:\\\/\\\/blog.basetis.com\\\/wp-content\\\/uploads\\\/2018\\\/10\\\/Keys_on_Keyboard.jpg\"},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/#website\",\"url\":\"https:\\\/\\\/blog.basetis.com\\\/\",\"name\":\"Basetis\",\"description\":\"Testing\",\"publisher\":{\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/blog.basetis.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"es\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/#organization\",\"name\":\"Basetis\",\"url\":\"https:\\\/\\\/blog.basetis.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"es\",\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/blog.basetis.com\\\/wp-content\\\/uploads\\\/2024\\\/02\\\/logo.svg\",\"contentUrl\":\"https:\\\/\\\/blog.basetis.com\\\/wp-content\\\/uploads\\\/2024\\\/02\\\/logo.svg\",\"width\":187,\"height\":29,\"caption\":\"Basetis\"},\"image\":{\"@id\":\"https:\\\/\\\/blog.basetis.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API keys en proyectos Android open source - Basetis","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/","og_locale":"es_ES","og_type":"article","og_title":"API keys en proyectos Android open source - Basetis","og_description":"En nuestros proyectos es habitual usar APIs de terceros que nos permiten a\u00f1adir funcionalidades sin tener que desarrollarlas nosotros mismos. Muchas APIs requieren el uso de keys que habremos obtenido al registrarnos como developers en alg\u00fan servicio (Twitter, Facebook, Instagram, etc\u2026) y solemos almacenar dichas keys en la t\u00edpica utils.class o apiKeys.class… Cuando subimos nuestro c\u00f3digo […]","og_url":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/","og_site_name":"Basetis","article_modified_time":"2024-03-12T11:42:28+00:00","og_image":[{"url":"https:\/\/blog.basetis.com\/wp-content\/uploads\/2018\/10\/Keys_on_Keyboard.jpg","width":1,"height":1,"type":"image\/jpeg"}],"twitter_card":"summary_large_image","twitter_misc":{"Tiempo de lectura":"2 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/","url":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/","name":"API keys en proyectos Android open source - Basetis","isPartOf":{"@id":"https:\/\/blog.basetis.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/#primaryimage"},"image":{"@id":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/#primaryimage"},"thumbnailUrl":"https:\/\/blog.basetis.com\/wp-content\/uploads\/2018\/10\/Keys_on_Keyboard.jpg","datePublished":"2017-02-10T12:05:36+00:00","dateModified":"2024-03-12T11:42:28+00:00","inLanguage":"es","potentialAction":[{"@type":"ReadAction","target":["https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/"]}]},{"@type":"ImageObject","inLanguage":"es","@id":"https:\/\/blog.basetis.com\/es\/article_basic\/api-keys-en-proyectos-android-open-source\/#primaryimage","url":"https:\/\/blog.basetis.com\/wp-content\/uploads\/2018\/10\/Keys_on_Keyboard.jpg","contentUrl":"https:\/\/blog.basetis.com\/wp-content\/uploads\/2018\/10\/Keys_on_Keyboard.jpg"},{"@type":"WebSite","@id":"https:\/\/blog.basetis.com\/#website","url":"https:\/\/blog.basetis.com\/","name":"Basetis","description":"Testing","publisher":{"@id":"https:\/\/blog.basetis.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/blog.basetis.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"es"},{"@type":"Organization","@id":"https:\/\/blog.basetis.com\/#organization","name":"Basetis","url":"https:\/\/blog.basetis.com\/","logo":{"@type":"ImageObject","inLanguage":"es","@id":"https:\/\/blog.basetis.com\/#\/schema\/logo\/image\/","url":"https:\/\/blog.basetis.com\/wp-content\/uploads\/2024\/02\/logo.svg","contentUrl":"https:\/\/blog.basetis.com\/wp-content\/uploads\/2024\/02\/logo.svg","width":187,"height":29,"caption":"Basetis"},"image":{"@id":"https:\/\/blog.basetis.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/article_basic\/17869","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/article_basic"}],"about":[{"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/types\/article_basic"}],"author":[{"embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/users\/866"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/comments?post=17869"}],"version-history":[{"count":1,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/article_basic\/17869\/revisions"}],"predecessor-version":[{"id":17870,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/article_basic\/17869\/revisions\/17870"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/media\/1313"}],"wp:attachment":[{"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/media?parent=17869"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/categories?post=17869"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/tags?post=17869"},{"taxonomy":"etiquetes","embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/etiquetes?post=17869"},{"taxonomy":"categorias","embeddable":true,"href":"https:\/\/blog.basetis.com\/es\/wp-json\/wp\/v2\/categorias?post=17869"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}