Documentation de l'API Joomag 2.0

Contacts

Obtenir la liste de contacts

Renvoie la liste des contacts sous votre compte.

GET /api/2.0/contacts

Exemple:

# 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();

Réponse:

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

Créez un contact

Crée un contact dans le compte

POST /api/2.0/contacts
Paramètre Type Explication
email séquence Adresse e-mail du contact
full_name séquence Nom complet du contact
country séquence Pays du contact
city séquence Ville de l'adresse
street séquence Rue
zip séquence Code postal du contact

Exemple:

# 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"
) );

Réponse:

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

Envoyer un seul numéro

Envoyer un seul numéro à contact spécifique.

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

Exemple:

# 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" );

Réponse:

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

Envoyer l'abonnement au magazine

Fournir l'abonnement d'un magazine à un contact spécifique.

POST /api/2.0/contacts/<email>/subscription/<magazine_id>
Paramètre Type Explication
cycle int Cycle d'abonnement du magazine. Doit être envoyé uniquement lors de la livraison d'abonnements payants. Peut avoir l'une des valeurs suivantes:
  • 1 - pour sept jours subscription
  • 2 - pendant 1 mois subscription
  • 3 - pendant 2 mois subscription
  • 4 - pendant 3 mois subscription
  • 5 - 6 mois subscription
  • 6 - pour 1 an subscription

Exemple:

# 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" );

Réponse:

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

Octroi d'accès

Fournissez l'accès au contact spécifié vers le problème payé ou avec tout problème pour lequel l'option de confidentialité est définie sur "Personnes uniquement de mon choix".

PUT /api/2.0/contacts/<email>/access/<issue_id>
notify_user booléen Indicateur booléen indiquant si l'utilisateur doit être averti par courrier électronique ou non. doit avoir la valeur no ou yes

Exemple:

# 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'
));

Réponse:

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

Accès révoquant

Révoquer l'accès des contacts spécifiés pour les problèmes qui ont été précédemment partagés avec lui / elle manuellement ou via une campagne

DELETE /api/2.0/contacts/<email>/access/<issue_id>
notify_user booléen Indicateur booléen indiquant si l'utilisateur doit être averti par courrier électronique ou non. doit avoir la valeur no ou yes

Exemple:

# 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'
));

Réponse:

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

Supprimer le contact

Supprime le contact désiré.

DELETE /api/2.0/contacts/<email>

Exemple:

# 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 );

Réponse:

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