Joomag API 2.0 Документация

Контакты

Получить список контактов

Возвращает список контактов аккаунта.

GET /api/2.0/contacts

Например:

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

Ответ:

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

Создать контакт

Создает контакт в аккаунте.

POST /api/2.0/contacts
Параметр Тип Разъяснение
email Строка Email контакта
full_name Строка Фамилия контакта
country Строка Страна контакта
city Строка Город
street Строка Улица
zip Строка Почтовый индекс

Например:

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

Ответ:

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

Отправить отдельный выпуск

Доставить отдельный выпуск выбранному контакту.

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

Например:

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

Ответ:

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

Отправить подписку на журнал

Доставить подписку на журнал отпределенному контакту.

POST /api/2.0/contacts/<email>/subscription/<magazine_id>
Параметр Тип Разъяснение
cycle int Цикл подписки журнала. Должно быть отправлено только при доставке платных подписок. Может иметь одно из следующих значений:
  • 1 - за 7-и дневнюю подписку
  • 2 - за месячную подписку
  • 3 - за 2-х месячную подписку
  • 4 - за 3-х месячную подписку
  • 5 - за 6-и месячную подписку
  • 6 - за годичную подписку

Например:

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

Ответ:

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

Предоставление доступа

Предоставление доступа к платным публикациям а также тем публикациям для которых задано значение конфиденциальности "Только люди, которых я выбираю" вашим контактам.

PUT /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Логический флаг, который указывает, следует ли уведомлять пользователя по электронной почте или нет; должен иметь значение no или yes

Например:

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

Ответ:

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

Отзыв доступа

Отозвать доступ для выбранных контактов к тем публикациям, которые ранее были переданы ему / ей, вручную или через кампанию

DELETE /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Логический флаг, который указывает, следует ли уведомлять пользователя по электронной почте или нет; должен иметь значение no или yes

Например:

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

Ответ:

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

Удалить контакт

Удаляет запрошенный контакт.

DELETE /api/2.0/contacts/<email>

Например:

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

Ответ:

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