Joomag API 2.0 Dokumentation

Kontakte

Kontaktliste abrufen

Zeigt eine Liste aller Kontakte Ihres Kontos an.

GET /api/2.0/contacts

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Make the call to the client.
$result = $jmClient->getContactsList();

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": [
    {
      "email": "john@example.com"
    },
    {
      "email": "ketty@example.com"
    },
    {
      "email": "baz@example.com"
    },
    {
      "email": "foo@example.com"
    }
  ]
}

Neuen Kontakt erstellen

Erstellt einen Kontakt in diesem Konto.

POST /api/2.0/contacts
Parameter Typ Erklärung
email string E-Mail Adresse des Kontakts
full_name string Vollständiger Name des Kontakts
country string Land des Kontakts
city string Stadt
street string Straße
zip string PLZ

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Make the call to the client.
$result = $jmClient->post( "contacts", array(
    "email"     => "john@example.com",
    "full_name" => "John Smith",
    "country"   => "US",
    "city"      => "New York",
    "street"    => "2250 Lexington Avenue",
    "zip"       => "10035"
) );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": {
    "email": "john@example.com"
  }
}

Einzelne Ausgabe versenden

Eine einzelne Ausgabe an bestimmten Kontakt ausliefern.

POST /api/2.0/contacts/<email>/issue/<issue_id>

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Subscriber email
$email = 'john@example.com';

# ID of the issue
$issueID = '0980693001409324380';

# Make the call to the client.
$result = $jmClient->post( "contacts/$email/issue/$issueID" );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Magazin-Abonnement versenden

Ein Magazin-Abonnement an bestimmten Kontakt ausliefern.

POST /api/2.0/contacts/<email>/subscription/<magazine_id>
Parameter Typ Erklärung
cycle int Abonnementzyklus der Zeitschrift. Muss nur bei Zustellung von kostenpflichtigen Abonnements gesendet werden. Kann einen der folgenden Werte haben:
  • 1 - für 7 Tage subscription
  • 2 - 1 Monat subscription
  • 3 - für 2 Monate subscription
  • 4 - für 3 Monate subscription
  • 5 - für 6 Monate subscription
  • 6 - 1 Jahr subscription

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Subscriber email
$email = 'john@example.com';

# ID of the magazine
$magazineID = 'M0166830001409317679';

# Make the call to the client.
$result = $jmClient->post( "contacts/$email/subscription/$magazineID" );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Zugriffsgewährung

Gewähren Sie den Zugriff auf den angegebenen Kontakt für eine kostenpflichtige Ausgabe oder für eine Ausgabe, bei der die Datenschutzoption auf "Nur von mir ausgewählte Personen" gesetzt ist.

PUT /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Boolesches Flag, das angibt, ob der Benutzer per E-Mail benachrichtigt werden soll oder nicht; Der Wert sollte entweder no oder yes sein

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Subscriber email
$email = 'john@example.com';

# ID of the issue
$issueID = '0980693001409324380';

# Make the call to the client.
$result = $jmClient->put( "contacts/$email/access/$issueID", array(
    'notify_user' => 'yes'
));

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Zugriff widerrufen

Widerrufen Sie den Zugriff von angegebenen Kontakten für die Ausgaben, die zuvor manuell oder über eine Kampagne für Sie freigegeben wurden

DELETE /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Boolesches Flag, das angibt, ob der Benutzer per E-Mail benachrichtigt werden soll oder nicht; Der Wert sollte entweder no oder yes sein

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Subscriber email
$email = 'john@example.com';

# ID of the issue
$issueID = '0980693001409324380';

# Make the call to the client.
$result = $jmClient->delete( "contacts/$email/access/$issueID", array(
    'notify_user' => 'yes'
));

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Kontakt löschen

Löscht den Kontakt.

DELETE /api/2.0/contacts/<email>

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Subscriber email
$email = 'john@example.com';

# Make the call to the client.
$result = $jmClient->deleteContact( $email );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}