Legacy Key Migration

As Keap phases out Legacy Keys we have worked to make it simple to keep your integrations functioning.

What is a Legacy Key?

Legacy Keys are our first form of API authentication. They were the single API key for a given Infusionsoft/Keap application, which all API consumers used to access that application’s data.

Why are we migrating from Legacy Keys?

Legacy Keys have several security problems that we need to address, including:

• The key is always visible in the UI, allowing anyone who can see it to use it indefinitely
• All consumers use the same key, making it impossible to determine individual traffic
• Having a single key means having to rotate that key everywhere in case of compromise
• The Legacy Key allowed access that bypasses our API proxies, preventing us from implementing more advanced traffic controls which are necessary for system performance

If: You use PHP to integrate

We have released a new version of our PHP SDK that supports an APIKey parameter, and your existing Legacy Key will continue to be functional via this authentication method.

You can also generate a new SAK (Service Account Key) in your Keap app and use that instead in the same manner, retiring your Legacy Key in favor of our current authentication methods to future-proof your integration, as we do plan to revoke all Legacy Keys in Q1 2025.

If: You use another language to integrate

You can continue to use your Legacy Key to make calls against the Keap API for now, but will have to make some minor alterations to your calls.

First, all calls must be routed to the main API endpoint, changing from:
https://YourInstanceId.infusionsoft.com/api/xmlrpc/v1
to:
https://api.infusionsoft.com/crm/xmlrpc

You will then need to change how you are sending your key to be a Header on the request, rather than a part of the XML POST body:
X-Keap-API-Key: YourLegacyKey

You can also generate a new SAK (Service Account Key) in your Keap app and use that instead in the same manner, retiring your Legacy Key in favor of our current authentication methods to future-proof your integration, as we do plan to revoke all Legacy Keys in Q1 2025. If you choose to do so, you can instead pass the SAK as a Bearer token (similar to JWT or OAuth) so that you don’t have to implement custom headers:
Authorization: Bearer YourSAK

Select your desired language to see examples:

cURL Javascript (Native) Javascript (using Axios) Python Java C# Go

	curl --location 'https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc' \
	--header 'Content-Type: application/xml' \
	--data '<?xml version=""1.0""?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>YOUR_LEGACY_KEY</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>'

view raw 01-Before.sh hosted with by GitHub

	curl --location 'https://api.infusionsoft.com/crm/xmlrpc' \
	--header 'Content-Type: application/xml' \
	--header 'X-Keap-Api-Key: YOUR_LEGACY_KEY' \
	--data '<?xml version=""1.0""?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>dummKey</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>'

view raw 02-After.sh hosted with by GitHub

	const url = 'https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc';
	const xmls = `<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>YOUR_LEGACY_KEY</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>`;
	const options = {
	method: 'POST',
	headers: {
	'Content-Type': 'application/xml',
	},
	body: xmls,
	};
	fetch(url, options)
	.then(response => response.text())
	.then(result => console.log(result))
	.catch(error => console.log('error', error));

view raw 1-Before.js hosted with by GitHub

	const url = 'https://api.infusionsoft.com/crm/xmlrpc';
	const xmls = `<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>dummKey</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>`;
	const options = {
	method: 'POST',
	headers: {
	'Content-Type': 'application/xml',
	'X-Keap-Api-Key': 'YOUR_LEGACY_KEY',
	},
	body: xmls,
	};
	fetch(url, options)
	.then(response => response.text())
	.then(result => console.log(result))
	.catch(error => console.log('error', error));

view raw 2-After.js hosted with by GitHub

	const axios = require('axios');
	const xmls = `<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>YOUR_LEGACY_KEY</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>`;
	axios({
	url: 'https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc',
	method: 'post',
	headers: {
	'Content-Type': 'application/xml',
	},
	data: xmls,
	})
	.then((response) => {
	console.log(response.data);
	})
	.catch((error) => {
	console.error(error);
	});

view raw 1-Before.js hosted with by GitHub

	const axios = require('axios');
	const xmls = `<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>dummKey</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>`;
	axios({
	url: 'https://api.infusionsoft.com/crm/xmlrpc',
	method: 'post',
	headers: {
	'Content-Type': 'application/xml',
	'X-Keap-Api-Key': 'YOUR_LEGACY_KEY',
	},
	data: xmls,
	})
	.then((response) => {
	console.log(response.data);
	})
	.catch((error) => {
	console.error(error);
	});

view raw 2-After.js hosted with by GitHub

	import requests
	url = "https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc"
	headers = {
	'Content-Type': 'application/xml',
	}
	data = """
	<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>YOUR_LEGACY_KEY</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>
	"""
	response = requests.post(url, headers=headers, data=data)
	print(response.text)

view raw 1-Before.py hosted with by GitHub

	import requests
	url = "https://api.infusionsoft.com/crm/xmlrpc"
	headers = {
	'Content-Type': 'application/xml',
	'X-Keap-Api-Key': 'YOUR_LEGACY_KEY',
	}
	data = """
	<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>dummKey</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>
	"""
	response = requests.post(url, headers=headers, data=data)
	print(response.text)

view raw 2-After.py hosted with by GitHub

	String url = "https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc";
	String xmls = "<?xml version=\"1.0\"?>\n" +
	"<methodCall>\n" +
	" <methodName>ContactService.listLinkedContacts</methodName>\n" +
	" <params>\n" +
	" <param>\n" +
	" <value><string>YOUR_LEGACY_KEY</string></value>\n" +
	" </param>\n" +
	" <param>\n" +
	" <value><int>1</int></value>\n" +
	" </param>\n" +
	" </params>\n" +
	"</methodCall>";
	URL obj = new URL(url);
	HttpURLConnection con = (HttpURLConnection) obj.openConnection();
	con.setRequestMethod("POST");
	con.setRequestProperty("Content-Type", "application/xml");
	con.setDoOutput(true);
	OutputStream os = con.getOutputStream();
	os.write(xmls.getBytes());
	os.flush();
	os.close();
	int responseCode = con.getResponseCode();
	System.out.println("Response Code : " + responseCode);
	Scanner s = new Scanner(con.getInputStream());
	while (s.hasNext()) {
	System.out.println(s.nextLine());
	}
	s.close();

view raw 1-Before.java hosted with by GitHub

	String url = "https://api.infusionsoft.com/crm/xmlrpc";
	String xmls = "<?xml version=\"1.0\"?>\n" +
	"<methodCall>\n" +
	" <methodName>ContactService.listLinkedContacts</methodName>\n" +
	" <params>\n" +
	" <param>\n" +
	" <value><string>dummKey</string></value>\n" +
	" </param>\n" +
	" <param>\n" +
	" <value><int>1</int></value>\n" +
	" </param>\n" +
	" </params>\n" +
	"</methodCall>";
	URL obj = new URL(url);
	HttpURLConnection con = (HttpURLConnection) obj.openConnection();
	con.setRequestMethod("POST");
	con.setRequestProperty("Content-Type", "application/xml");
	con.setRequestProperty("X-Keap-Api-Key", "YOUR_LEGACY_KEY");
	con.setDoOutput(true);
	OutputStream os = con.getOutputStream();
	os.write(xmls.getBytes());
	os.flush();
	os.close();
	int responseCode = con.getResponseCode();
	System.out.println("Response Code : " + responseCode);
	Scanner s = new Scanner(con.getInputStream());
	while (s.hasNext()) {
	System.out.println(s.nextLine());
	}
	s.close();

view raw 2-After.java hosted with by GitHub

	var url = "https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc";
	var xmls = @"<?xml version=""1.0""?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>YOUR_LEGACY_KEY</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>";
	var httpContent = new StringContent(xmls, Encoding.UTF8, "application/xml");
	var response = await client.PostAsync(url, httpContent);
	var responseString = await response.Content.ReadAsStringAsync();

view raw 1-Before.cs hosted with by GitHub

	var url = "https://api.infusionsoft.com/crm/xmlrpc";
	var xmls = @"<?xml version=""1.0""?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>dummKey</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>";
	var httpContent = new StringContent(xmls, Encoding.UTF8, "application/xml");
	client.DefaultRequestHeaders.Add("X-Keap-Api-Key", "YOUR_LEGACY_KEY");
	var response = await client.PostAsync(url, httpContent);
	var responseString = await response.Content.ReadAsStringAsync();

view raw 2-After.cs hosted with by GitHub

	package main
	import (
	"bytes"
	"io/ioutil"
	"log"
	"net/http"
	)
	func main() {
	url := "https://YOUR_TENANT_ID.infusionsoft.com/api/xmlrpc"
	method := "POST"
	payload := []byte(`<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>YOUR_LEGACY_KEY</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>`)
	client := &http.Client{}
	req, err := http.NewRequest(method, url, bytes.NewBuffer(payload))
	if err != nil {
	log.Fatalf("An Error Occured %v", err)
	}
	req.Header.Add("Content-Type", "application/xml")
	resp, err := client.Do(req)
	if err != nil {
	log.Fatalf("An Error Occured %v", err)
	}
	defer resp.Body.Close()
	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
	log.Fatalf("An Error Occured %v", err)
	}
	log.Printf(string(body))
	}

view raw 1-Before.go hosted with by GitHub

	package main
	import (
	"bytes"
	"io/ioutil"
	"log"
	"net/http"
	)
	func main() {
	url := "https://api.infusionsoft.com/crm/xmlrpc"
	method := "POST"
	payload := []byte(`<?xml version="1.0"?>
	<methodCall>
	<methodName>ContactService.listLinkedContacts</methodName>
	<params>
	<param>
	<value><string>dummKey</string></value>
	</param>
	<param>
	<value><int>1</int></value>
	</param>
	</params>
	</methodCall>`)
	client := &http.Client{}
	req, err := http.NewRequest(method, url, bytes.NewBuffer(payload))
	if err != nil {
	log.Fatalf("An Error Occured %v", err)
	}
	req.Header.Add("Content-Type", "application/xml")
	req.Header.Add("X-Keap-Api-Key", "YOUR_LEGACY_KEY")
	resp, err := client.Do(req)
	if err != nil {
	log.Fatalf("An Error Occured %v", err)
	}
	defer resp.Body.Close()
	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
	log.Fatalf("An Error Occured %v", err)
	}
	log.Printf(string(body))
	}

view raw 2-After.go hosted with by GitHub

If: You are a third-party integrator

We require that third-party integrators use our OAuth2 Bearer tokens, for security and scalability. You can find complete instructions on our OAuth2 documentation page.

Timeline

Conclusion

If you have questions regarding implementing these changes you can find support from other developers on our Integration community, or with Keap API Support team through our developer ticketing system.