Unser aktuelles Promotion-Modul wird durch eine neue Version inkl. API ersetzt. Diese befindet sich gerade noch in der Beta-Phase. Wenn ihr eure Webseite neu anbinden möchtet, kontaktiert uns bitte via support@copilot.events.

Authentifizierung

Um die read-api zu nutzen, muss für einen User ein Access Token erzeugt werden.

Der Access Token muss im Header des Requests als Bearer Token übergeben werden. Die angegebene instanzId entsprechend ersetzen.

  curl -i https://copilot.events/{instanzId}/api/events \
  -H "Authorization: Bearer {token}"

Status Codes

Folgende HTTP Status Codes können zurückgegeben werden:

Status CodeAnmerkung
200OK (Erfolgreiche Abfrage)
400Bad Request (Invalide Parameter)
401Unauthorized (Invalider oder fehlender Access Token)
404Not Found (Nicht gefundenes Event)
500Internal Server Error (Unerwarteter Serverfehler)

Code Beispiele

Javascript 

  var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer {token}");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://copilot.events/{instanzId}/api/events", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP 

  <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://copilot.events/{instanzId}/api/events',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer {token}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;