{"id":905,"date":"2020-10-21T08:22:22","date_gmt":"2020-10-21T15:22:22","guid":{"rendered":"https:\/\/wpdatasync.com\/?post_type=wp_data_sync_doc&#038;p=905"},"modified":"2020-11-22T11:10:32","modified_gmt":"2020-11-22T18:10:32","slug":"remote-key","status":"publish","type":"wp_data_sync_doc","link":"https:\/\/wpdatasync.com\/documentation\/remote-key\/","title":{"rendered":"Remote Key"},"content":{"rendered":"\n<p>Remote key is the key you will use to name the data field on your remote website. <\/p>\n\n\n\n<h2 class=\"wp-block-heading\">New Development<\/h2>\n\n\n\n<p>If you are developing new functionality. You can use any naming convention that works for your project.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Populate Remote Keys in Remote Website Database<\/h3>\n\n\n\n<ol class=\"wp-block-list\"><li>Activate the new plugin or theme that uses the meta keys<\/li><li>Create a sample post, page, or whatever post type uses the new meta keys (this will add the keys to your websites database)<\/li><li>Request Remote Keys again in the WP Data Sync API<\/li><\/ol>\n\n\n\n<h2 class=\"wp-block-heading\">Integrating with Existing Functionality<\/h2>\n\n\n\n<p>If you are integrating with an existing plugin or theme. You should name the remote key with that systems naming convention.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Remote Keys &#8211; Imported<\/h3>\n\n\n\n<p>Remote Keys &#8211; Imported are the keys obtained from your remote website. You must obtain these keys before they are available for use in the WP Data Sync API.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1024x398.png\" alt=\"WP Data Sync Imported Remote Keys\" class=\"wp-image-1033\" width=\"1024\" height=\"398\" srcset=\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1024x398.png 1024w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-416x162.png 416w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-300x117.png 300w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-768x298.png 768w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1536x597.png 1536w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-2048x796.png 2048w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-400x155.png 400w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p><strong>Note:<\/strong> If you have not used the functionality that requires a specific key in remote website, the key may not be available. See above: <strong>Populate Remote Keys in Remote Website Database<\/strong><\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Obtaining existing remote keys<\/h4>\n\n\n\n<p>To obtain a list of existing remote keys. First, insure your remote website is connected to the WP Data Sync API. Then, click the Remote Keys tab in your Data Source. Last, click Request Remote Keys. This will obtain a list of keys from your remote website. <\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Remote Keys UI<\/h2>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"606\" src=\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-1024x606.png\" alt=\"WP Data Sync Remote Keys UI\" class=\"wp-image-906\" srcset=\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-1024x606.png 1024w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-416x246.png 416w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-300x177.png 300w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-768x454.png 768w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-1536x909.png 1536w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-2048x1211.png 2048w, https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/wp-data-sync-remote-keys-400x237.png 400w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n","protected":false},"parent":0,"template":"","doc_type":[65],"class_list":{"0":"post-905","1":"wp_data_sync_doc","2":"type-wp_data_sync_doc","3":"status-publish","5":"doc_type-getting-started","6":"entry"},"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v25.7.1 (Yoast SEO v26.6) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Remote Key - WP Data Sync<\/title>\n<meta name=\"description\" content=\"Developer Documentation - Remote Key - WP Data Sync is a developer friendly plugin\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/wpdatasync.com\/documentation\/remote-key\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Remote Key\" \/>\n<meta property=\"og:description\" content=\"Developer Documentation - Remote Key - WP Data Sync is a developer friendly plugin\" \/>\n<meta property=\"og:url\" content=\"https:\/\/wpdatasync.com\/documentation\/remote-key\/\" \/>\n<meta property=\"og:site_name\" content=\"WP Data Sync\" \/>\n<meta property=\"article:modified_time\" content=\"2020-11-22T18:10:32+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1024x398.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/\",\"url\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/\",\"name\":\"Remote Key - WP Data Sync\",\"isPartOf\":{\"@id\":\"https:\/\/wpdatasync.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1024x398.png\",\"datePublished\":\"2020-10-21T15:22:22+00:00\",\"dateModified\":\"2020-11-22T18:10:32+00:00\",\"description\":\"Developer Documentation - Remote Key - WP Data Sync is a developer friendly plugin\",\"breadcrumb\":{\"@id\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/wpdatasync.com\/documentation\/remote-key\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/#primaryimage\",\"url\":\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys.png\",\"contentUrl\":\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys.png\",\"width\":3062,\"height\":1190},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/wpdatasync.com\/documentation\/remote-key\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/wpdatasync.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/wpdatasync.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Getting Started\",\"item\":\"https:\/\/wpdatasync.com\/documentation-type\/getting-started\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Remote Key\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/wpdatasync.com\/#website\",\"url\":\"https:\/\/wpdatasync.com\/\",\"name\":\"WP Data Sync\",\"description\":\"The only data sync API for WordPress websites.\",\"publisher\":{\"@id\":\"https:\/\/wpdatasync.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/wpdatasync.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/wpdatasync.com\/#organization\",\"name\":\"WP Data Sync\",\"url\":\"https:\/\/wpdatasync.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/wpdatasync.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/poster.png\",\"contentUrl\":\"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/poster.png\",\"width\":3480,\"height\":2160,\"caption\":\"WP Data Sync\"},\"image\":{\"@id\":\"https:\/\/wpdatasync.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.linkedin.com\/company\/70502156\/admin\/\",\"https:\/\/www.youtube.com\/channel\/UCTWNRGTGaZRO2S3BRAbjY8w\"]}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Remote Key - WP Data Sync","description":"Developer Documentation - Remote Key - WP Data Sync is a developer friendly plugin","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:\/\/wpdatasync.com\/documentation\/remote-key\/","og_locale":"en_US","og_type":"article","og_title":"Remote Key","og_description":"Developer Documentation - Remote Key - WP Data Sync is a developer friendly plugin","og_url":"https:\/\/wpdatasync.com\/documentation\/remote-key\/","og_site_name":"WP Data Sync","article_modified_time":"2020-11-22T18:10:32+00:00","og_image":[{"url":"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1024x398.png","type":"","width":"","height":""}],"twitter_card":"summary_large_image","schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/wpdatasync.com\/documentation\/remote-key\/","url":"https:\/\/wpdatasync.com\/documentation\/remote-key\/","name":"Remote Key - WP Data Sync","isPartOf":{"@id":"https:\/\/wpdatasync.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/wpdatasync.com\/documentation\/remote-key\/#primaryimage"},"image":{"@id":"https:\/\/wpdatasync.com\/documentation\/remote-key\/#primaryimage"},"thumbnailUrl":"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys-1024x398.png","datePublished":"2020-10-21T15:22:22+00:00","dateModified":"2020-11-22T18:10:32+00:00","description":"Developer Documentation - Remote Key - WP Data Sync is a developer friendly plugin","breadcrumb":{"@id":"https:\/\/wpdatasync.com\/documentation\/remote-key\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/wpdatasync.com\/documentation\/remote-key\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/wpdatasync.com\/documentation\/remote-key\/#primaryimage","url":"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys.png","contentUrl":"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/11\/wp-data-sync-imported-remote-keys.png","width":3062,"height":1190},{"@type":"BreadcrumbList","@id":"https:\/\/wpdatasync.com\/documentation\/remote-key\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/wpdatasync.com\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/wpdatasync.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"Getting Started","item":"https:\/\/wpdatasync.com\/documentation-type\/getting-started\/"},{"@type":"ListItem","position":4,"name":"Remote Key"}]},{"@type":"WebSite","@id":"https:\/\/wpdatasync.com\/#website","url":"https:\/\/wpdatasync.com\/","name":"WP Data Sync","description":"The only data sync API for WordPress websites.","publisher":{"@id":"https:\/\/wpdatasync.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/wpdatasync.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/wpdatasync.com\/#organization","name":"WP Data Sync","url":"https:\/\/wpdatasync.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/wpdatasync.com\/#\/schema\/logo\/image\/","url":"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/poster.png","contentUrl":"https:\/\/wpdatasync.com\/wp-content\/uploads\/2020\/10\/poster.png","width":3480,"height":2160,"caption":"WP Data Sync"},"image":{"@id":"https:\/\/wpdatasync.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/70502156\/admin\/","https:\/\/www.youtube.com\/channel\/UCTWNRGTGaZRO2S3BRAbjY8w"]}]}},"_links":{"self":[{"href":"https:\/\/wpdatasync.com\/wp-json\/wp\/v2\/wp_data_sync_doc\/905","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wpdatasync.com\/wp-json\/wp\/v2\/wp_data_sync_doc"}],"about":[{"href":"https:\/\/wpdatasync.com\/wp-json\/wp\/v2\/types\/wp_data_sync_doc"}],"wp:attachment":[{"href":"https:\/\/wpdatasync.com\/wp-json\/wp\/v2\/media?parent=905"}],"wp:term":[{"taxonomy":"doc_type","embeddable":true,"href":"https:\/\/wpdatasync.com\/wp-json\/wp\/v2\/doc_type?post=905"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}