Ruby

Get Populi Access Key (Token)

See more Populi Examples

Demonstrates how to authenticate and obtain an access key using a username and password. Ruby

require 'chilkat'

success = false

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

# Connect using TLS.
# A single REST object, once connected, can be used for many Populi REST API calls.
# The auto-reconnect indicates that if the already-established HTTPS connection is closed,
# then it will be automatically re-established as needed.
bAutoReconnect = true
success = rest.Connect("yourcollege.populi.co",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

rest.AddQueryParam("username","POPULI_USERNAME")
rest.AddQueryParam("password","POPULI_PASSWORD")

responseBody = rest.fullRequestFormUrlEncoded("POST","/api/index.php")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print responseBody + "\n";
    exit
end

xml = Chilkat::CkXml.new()
xml.LoadXml(responseBody)
print xml.getXml() + "\n";

# Sample response:
# <?xml version="1.0" encoding="ISO-8859-1"?>
# <response>
# <access_key>63481e36023b5d ... 76d0dbc314</access_key>
#     <accountid>19999999</accountid>
#     <accounttype>PERSON</accounttype>
# </response>

# Save the XML to a file for subsequent requests..
xml.SaveXml("qa_data/tokens/populi_token.xml")