Notre interface OData REST envoie et reçoit des données conformément à l'Open Data Protocol.
Nous vous recommandons d'étudier les tutoriels suivants avant d'utiliser notre interface:
Vous trouverez les métadonnées de notre interface ici: https://api.beyond-sw.ch/$metadata
L'interface est documentée à l'aide de Swagger: https://api.beyond-sw.ch/help
Veuillez noter que notre API renvoie un maximum de 100 enregistrements à la fois. Si plus d'enregistrements correspondent aux critères, la réponse contiendra un @odata.nextLink.
Token
Pour les fonctions protégées de l'interface REST, vous avez besoin d'un token de support. Pour l'obtenir, procédez comme suit:
HttpRequest | |
Type | POST |
Url | /Token |
Headers |
|
Content-Type | application/x-www.form-urlencoded |
Body |
|
grant_type | password |
username | Benutzername für den API-Zugriff |
password | Passwort für den API-Zugriff |
Vous utilisez ce jeton lors d'un appel précédé de "Bearer". Par exemple:
Bearer 123456789
Retour attendu (exemple)
{
"access_token": "Beispiel",
"token_type": "bearer",
"expires_in": 3599,
"userName": "00000000-0000-0000-0000-000000000000",
".issued": "Sat, 04 Apr 2020 08:05:08 GMT",
".expires": "Sat, 04 Apr 2020 09:05:08 GMT"
}
API-Url
L'url pour l'accès à l'API est : https://api.beyond-sw.ch.
Nom d'utilisateur API et mot de passe API
Pour demander un token, vous avez besoin d'un nom d'utilisateur et d'un mot de passe. Vous pouvez les obtenir auprès de support@beyond-sw.ch.
Exemple pour php
<html>
<head>
<title>PHP Test</title>
</head>
<body>
<?php
$url = 'https://api.beyond-sw.ch/';
$userName = 'Benutzername für den API-Zugriff';
$key = 'Passwort für den API-Zugriff';
$token = requestToken();
$values = requestValues('kurse');
var_dump($values[0]['value']);
function requestToken()
{
global $url, $userName, $key;
$data = array(
'grant_type' => 'password',
'username' => $userName,
'password' => $key);
$handle = curl_init($url .'token');
curl_setopt($handle, CURLOPT_POST, 1);
curl_setopt($handle, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($handle, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
curl_setopt($handle, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($handle);
$jsonRaw = json_decode($response, true);
curl_close($handle);
return $jsonRaw['access_token'];
}
function requestValues($path, $returnField = null )
{
global $url, $token;
$header = array(
'Content-Type: application/json',
'Authorization: Bearer ' . $token);
$handle = curl_init();
curl_setopt($handle, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($handle, CURLOPT_TIMEOUT, 100);
curl_setopt($handle, CURLOPT_HTTPHEADER, $header);
curl_setopt($handle, CURLOPT_URL, $url . $path);
$response = curl_exec($handle);
if ($returnField == null)
$jsonRaw = json_decode("[". $response . "]", true);
else
$jsonRaw = json_decode($response, true);
curl_close($handle);
if ($returnField == null)
return $jsonRaw;
else
return $jsonRaw[$returnField];
}
?>
</body>
</html>
Commentaires
Vous devez vous connecter pour laisser un commentaire.