API-avaimen käyttöesimerkkejä

Seuraavassa pari esimerkkiä miten käytät API-avainta rajapinnoissa.

.NET 4.x ja VB.net

'Luodaan ilmentymä autentikointipalvelusta
Dim oLoginServiceClient as New Lemonsoft.AuthenticationServiceClient
'Täytetään login tiedot
Dim oInfo as New Lemonsoft.LoginInfo
oInfo.UserName = "user@domain.fi"
oInfo.Password = "yuuT54A!"
oInfo.CompanyDatabase = "LemonDB2"
oInfo.ApiKey = "c5f0fb8149bd4f6fbd2a7ea403f468cd5b8a88d4c035436f85a4c5089080"

Dim oLoginResult = oClient.LogIn(oInfo)
Dim strResultAsText = oLoginResult.ResultText
Dim strSessionID = oLoginResult.SessioID

Virhetilanteiden selitteet:

Jos API-KEY puuttuu, ResultText: API-KEY MISSING

Jos API KEY on väärä, ResultText : Unable to get companylicenses for user

Jos instanssiID tai SQL tunnistautuminen ei onnistu, ResultText : Unable to login to instance and database

PHP

$username = "käyttäjänimi";
$password = "salasana";
$database = "tietokanta";
$apikey = "apiavain";
$url = "https://webservice.saas.cldpart.net/example-soap/UserServices.svc?singleWsdl";

$options = array(
    'cache_wsdl' => 1,
    'trace' => 1,
    'stream_context' => stream_context_create(array(
        'ssl' => array(
            'verify_peer' => false,
            'verify_peer_name' => false,
            'allow_self_signed' => true
        )
    ))
);

// luodaan client
$client = new SoapClient($url, $options);

// kirjaudutaan sisään
$login_data = array(
    "oLogInInfo" => array(
        "UserName" => $username,
        "Password" => $password,
        "CompanyDatabase" => $database,
        "ApiKey" => $apikey
    )
);
$response = $client->LogIn($login_data);

// otetaan session id talteen
$session_id = $response->LogInResult->SessioID;

// haetaan asiakaslista
$data = array(
    "strSessionID" => $session_id
);
$getCustomerListResult = $client->GetCustomerList($data);

// tulostetaan vastaus
echo "<pre>";
print_r($getCustomerListResult);