PureBasic

Get Populi Access Key (Token)

See more Populi Examples

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

IncludeFile "CkRest.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

    success.i = 0

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.i = 1
    success = CkRest::ckConnect(rest,"yourcollege.populi.co",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    CkRest::ckAddQueryParam(rest,"username","POPULI_USERNAME")
    CkRest::ckAddQueryParam(rest,"password","POPULI_PASSWORD")

    responseBody.s = CkRest::ckFullRequestFormUrlEncoded(rest,"POST","/api/index.php")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; We should expect a 200 response if successful.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug responseBody
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadXml(xml,responseBody)
    Debug CkXml::ckGetXml(xml)

    ; 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..
    CkXml::ckSaveXml(xml,"qa_data/tokens/populi_token.xml")


    CkRest::ckDispose(rest)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure