There are two authentication methods you will need to utilize:

 

• Basic Authentication to retrieve the userkey
  
  
• UserKey Authentication for all API calls after the userkey has been retrieved

 

 

 

Authenticating via Basic Authentication

• Basic Authentication requires a Username, Password, and an APIKey encoded in base64.
  
  
• While the Username and Password should not need an introduction, you might not know exactly what our APIKey represents.
  
  
• The ApiKey is a unique identifier assigned to a partner and allows access to the API.  Every APIKey is unique and has its own data associated with it. (see sample record below)

 

APIKey Record

<APIKey>72f4d39a-1858-40f0-955d-4b9fb21d98f8</APIKey>   <Name>Redtail Technology</Name>   <URL>http://www.redtailtechnology.com</URL>;   <Institution>0</Institution>

 

 

 

How do I supply the credentials?

• Below, you can see that the credentials are supplied in the request header as a string, with each credential separated by a single colon. The credentials are secured via SSL.

 

 

"APIKey:Username:Password"
"72f4d39a-1858-40f0-955d-4b9fb21d98f8:APITest:P@ss123456!"

 

 

• When supplying the credentials, you will need to use base64 encoding, as well as specify the Basic authentication type.
  See bolded string in request header example below.(C#)

 

 

//using system.net;

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://crm.redtailtechnology.com/api/public/v1/authentication"");

 

 

• This endpoint will return the API userkey discussed below. 

 

req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("72f4d39a-1858-40f0-955d-4b9fb21d98f8:APITest:P@ss123456!"));

 

EXAMPLE:

72f4d39a-1858-40f0-955d-4b9fb21d98f8:APITest:P@ss123456! >> base64 encoded = NzJmNGQzOWEtMTg1OC00MGYwLTk1NWQtNGI5ZmIyMWQ5OGY4OkFQSVRlc3Q6UEBzczEyMzQ1NiE=

The header for a call using basic authentication should look like ‘Authorization: Basic NzJmNGQzOWEtMTg1OC00MGYwLTk1NWQtNGI5ZmIyMWQ5OGY4OkFQSVRlc3Q6UEBzczEyMzQ1NiE=’

req.Method = "GET";

req.ContentType = "text/xml";

 

 

 

 

 

Your Credentials

• If you do not already have credentials for a Redtail database to use for testing, please create a trial database by filling out the free trial creation wizard here. https://accounts.redtailtechnology.com/new_user/1?Product=leapfrog.
  
  
• Please reach out to  partnersupport@redtailtechnology.com with your username once you have created your trial account.  If you already have a Redtail account but are not able to access it, please reach out to support@redtailtechnology.com to request assistance.

 

 

 

Authenticating via UserKey

• UserKey Authentication requires an APIKey and a UserKey and does NOT expire.
  
  
• The UserKey is a unique Identifier for an individual user and remains constant regardless of whether a User decides to change their password.
  
  
• All API calls should be authenticated with the UserKey once you've obtained the user's UserKey.
  
  
• Supplying the credentials is similar for all of our authentication method types. As seen in the Basic Authentication method, the credentials are colon delimited.

 

 

"APIKey:UserKey"

"72f4d39a-1858-40f0-955d-4b9fb21d98f8:84AA7203-5106-449B-A9D4-37BD50497536"

 

 

• Just as before, when supplying the credentials you will need to use base64 encoding. However, you will want to specify the authentication type in the request header as "UserkeyAuth " Please see example below.(C#)

 

 

//using system.net;

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://crm.redtailtechnology.com/api/public/v1/contacts/384843/notes""");

req.Headers[System.Net.HttpRequestHeader.Authorization] = "Userkeyauth " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("72f4d39a-1858-40f0-955d-4b9fb21d98f8:84AA7203-5106-449B-A9D4-37BD50497536"));
req.Method = "GET";

req.ContentType = "text/xml";  

 

 

EXAMPLE:

72f4d39a-1858-40f0-955d-4b9fb21d98f8:84AA7203-5106-449B-A9D4-37BD50497536 >> base64 encoded = NzJmNGQzOWEtMTg1OC00MGYwLTk1NWQtNGI5ZmIyMWQ5OGY4Ojg0QUE3MjAzLTUxMDYtNDQ5Qi1BOUQ0LTM3QkQ1MDQ5NzUzNg==

The header for a call using UserKey authentication should look like ‘Authorization: UserKeyAuth NzJmNGQzOWEtMTg1OC00MGYwLTk1NWQtNGI5ZmIyMWQ5OGY4Ojg0QUE3MjAzLTUxMDYtNDQ5Qi1BOUQ0LTM3QkQ1MDQ5NzUzNg==’