Exigo Web Services API v2024.9.6.6

 Search

CreateSilentLoginCipher

Creates backoffice silent login authentication cipher

Input Properties

CreateSilentLoginCipherRequest
PropertyData TypeNotes
SilentLoginKeyStringSilent login key.
CustomerIDInt32Optional. Unique numeric identifier for customer record. Defaults to 0.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exception will occur if CustomerID & CustomerKey are provided.
UserIDStringUnique alpha numeric identifier which represents the external calling user identifier.
RouteStringOptional. Optional route to redirect to once authenticated.

Output Properties

CreateSilentLoginCipherResponse
PropertyData TypeNotes
SilentLoginCipherStringSilent Login Cipher.

Http Request

GET https://yourcompany-api.exigo.com/3.0/customers/createsilentlogincipher?silentLoginKey=1
  &customerID=1
  &customerKey=1
  &userID=1
  &route=1
Authorization: Basic base64Encoded

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length


{
  "silentLoginCipher": "",
  "result": null
}

Soap Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: lifewave-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/CreateSilentLoginCipher"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ApiAuthentication xmlns="http://api.exigo.com/">
      <LoginName>string</LoginName>
      <Password>string</Password>
      <Company>string</Company>
      <Identity>string</Identity>
      <RequestTimeUtc>dateTime</RequestTimeUtc>
      <Signature>string</Signature>
    </ApiAuthentication>
  </soap:Header>
  <soap:Body>
    <silentLoginCipherRequest xmlns="http://api.exigo.com/">
      <SilentLoginKey>string</SilentLoginKey>
      <CustomerID>int</CustomerID>
      <CustomerKey>string</CustomerKey>
      <UserID>string</UserID>
      <Route>string</Route>
    </silentLoginCipherRequest>
  </soap:Body>
</soap:Envelope>

Soap Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateSilentLoginCipherResult xmlns="http://api.exigo.com/">
      <SilentLoginCipher>string</SilentLoginCipher>
    </CreateSilentLoginCipherResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new CreateSilentLoginCipherRequest();

 

    req.SilentLoginKey = "1";       //Silent login key.

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exception will occur if CustomerID & CustomerKey are provided.

    req.UserID = "1";               //Unique alpha numeric identifier which represents the external calling user identifier.

    req.Route = "1";                //Optional route to redirect to once authenticated.

 

    //Send Request to Server and Get Response

    var res = await api.CreateSilentLoginCipherAsync(req);

 

    //Now examine the results:

    Console.WriteLine("SilentLoginCipher: {0}", res.SilentLoginCipher);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

C# Soap Client

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    CreateSilentLoginCipherRequest req = new CreateSilentLoginCipherRequest();

 

    req.SilentLoginKey = "1";       //Silent login key.

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exception will occur if CustomerID & CustomerKey are provided.

    req.UserID = "1";               //Unique alpha numeric identifier which represents the external calling user identifier.

    req.Route = "1";                //Optional route to redirect to once authenticated.

 

    //Send Request to Server and Get Response

    CreateSilentLoginCipherResponse res = api.CreateSilentLoginCipher(req);

 

    //Now examine the results:

    Console.WriteLine("SilentLoginCipher: {0}", res.SilentLoginCipher);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new CreateSilentLoginCipherRequest()

 

    req.SilentLoginKey = "1"

    req.CustomerID = 1

    req.CustomerKey = "1"

    req.UserID = "1"

    req.Route = "1"

 

    'Send Request to Server and Get Response

    Dim res As CreateSilentLoginCipherResponse = api.CreateSilentLoginCipher(req)

 

    'Now examine the results:

    Console.WriteLine("SilentLoginCipher: {0}", res.SilentLoginCipher)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->SilentLoginKey = "1";

    $req->CustomerID = 1;

    $req->CustomerKey = "1";

    $req->UserID = "1";

    $req->Route = "1";

 

    //Send Request to Server and Get Response

    $res = $api.CreateSilentLoginCipher($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    CreateSilentLoginCipherRequest req = new CreateSilentLoginCipherRequest();

 

    req.setSilentLoginKey("1");

    req.setCustomerID(1);

    req.setCustomerKey("1");

    req.setUserID("1");

    req.setRoute("1");

 

    //Send Request to Server and Get Response

    CreateSilentLoginCipherResponse res = api.getExigoApiSoap().createSilentLoginCipher(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.