API User Guide

This is a C# example of how to log into Tungsten AP Essentials using the REST API with cookie authentication.

class Program
{
  private static Uri authUri =
   new Uri("https://services.readsoftonline.com/authentication/rest/authenticate");

  private static Cookie currentCookie = null;

  private static void Main(string[] args)
  {
    Authenticate();
  }

  private static void Authenticate()
  {
    HttpWebRequest client = (HttpWebRequest)HttpWebRequest.Create(authUri);

    client.CookieContainer = new CookieContainer();
    client.Accept = "application/xml";
    client.ContentType = "application/xml";
    client.Headers.Add("x-rs-version", "2011-10-14");
    client.Headers.Add("x-rs-key", "1F6C568B-84DA-43FB-A9CE-80FB4E0B6EFA");
    client.Headers.Add("x-rs-culture", CultureInfo.CurrentCulture.Name);
    client.Headers.Add("x-rs-uiculture", CultureInfo.CurrentUICulture.Name);
    client.Method = "POST";

    using (Stream request = client.GetRequestStream())
    {
      using (StreamWriter sr = new StreamWriter(request, Encoding.UTF8))
      {
        sr.Write("<AuthenticationCredentials>");
        sr.Write("<UserName>account_name</UserName>");
        sr.Write("<Password>account_password</Password>");
        sr.Write("<AuthenticationType>SetCookie</AuthenticationType>");
        sr.Write("</AuthenticationCredentials>");
      }
    }

    using (WebResponse response = client.GetResponse())
    {
      using (Stream resp = response.GetResponseStream())
      {
        using (StreamReader sr = new StreamReader(resp, Encoding.UTF8))
        {
          System.Diagnostics.Debug.WriteLine(sr.ReadToEnd());
        }
      }
    }

    if (client.CookieContainer.Count > 0)
    {
      currentCookie = client.CookieContainer.GetCookies(authUri)[0];
    }
  }
}
 

This is a C# example of how to log into Tungsten AP Essentials using the REST API without cookie authentication.

When you successfully authenticate without a cookie, the response includes an authentication token that is valid for 30 minutes. After 30 minutes, the client must call the Authenticate API endpoint again to receive a new token.

See also Authenticate REST examples.

class Program
{
  private static readonly Uri AuthUri =
      new Uri("https://services.readsoftonline.com/authentication/rest/authenticate");

  private static readonly Uri CurrentUserUri =
      new Uri("https://services.readsoftonline.com/users/rest/currentuser");

  private static string ApiKey = "11111111-2222-3333-4444-555555555555";

  private static void Main(string[] args)
  {
    Authenticate();
  }

  private static void Authenticate()
  {
    var loginRequest = (HttpWebRequest)WebRequest.Create(AuthUri);

    loginRequest.Accept = "application/xml";
    loginRequest.ContentType = "application/xml";
    loginRequest.Headers.Add("x-rs-key", ApiKey);
    loginRequest.Method = "POST";

    using (var request = loginRequest.GetRequestStream())
    using (var sr = new StreamWriter(request, Encoding.UTF8))
    {
      sr.Write("<AuthenticationCredentials>");
      sr.Write("<UserName>account_name</UserName>");
      sr.Write("<Password>account_password</Password>");
      sr.Write("<AuthenticationType>SetBodyToken</AuthenticationType>");
      sr.Write("</AuthenticationCredentials>");
    }

    string authenticationToken;

    using (var response = loginRequest.GetResponse())
    using (var responseStream = response.GetResponseStream())
    using (var streamReader = new StreamReader(responseStream, Encoding.UTF8))
    {
      var body = streamReader.ReadToEnd();

      var xmlDocument = new XmlDocument { XmlResolver = null };
      xmlDocument.LoadXml(body);

      authenticationToken = xmlDocument.SelectSingleNode("/AuthenticationResult/Token").InnerText;
    }

    var getCurrentUserRequest = (HttpWebRequest)WebRequest.Create(CurrentUserUri);
    getCurrentUserRequest.Accept = "application/xml";
    getCurrentUserRequest.ContentType = "application/xml";
    getCurrentUserRequest.Headers.Add("x-rs-key", ApiKey);
    getCurrentUserRequest.Headers.Add("Authorization", $"ApsToken Value=\"{authenticationToken}\"");
    getCurrentUserRequest.Method = "GET";

    using (var response = getCurrentUserRequest.GetResponse())
    using (var responseStream = response.GetResponseStream())
    using (var streamReader = new StreamReader(responseStream, Encoding.UTF8))
    {
      var body = streamReader.ReadToEnd();

      var xmlDocument = new XmlDocument { XmlResolver = null };
      xmlDocument.LoadXml(body);

      var fullName = xmlDocument.SelectSingleNode("/User2/FullName").InnerText;

      Console.WriteLine($"Hello {fullName}");
    }
  }
}