Documentación API Joomag 2.0

Contactos

Obtener Lista de Contactos

Recupere lista de contactos en su cuenta.

GET /api/2.0/contacts

Ejemplo:

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

Respuesta:

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

Crear un Contacto

Crear un contacto en esta cuenta.

POST /api/2.0/contacts
Parámetro Tipo Explicación
email cadena Correo del contacto
full_name cadena Nombre completo del contacto
country cadena País del contacto
city cadena Ciudad de correo
street cadena Calle
zip cadena Código postal del contacto

Ejemplo:

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

Respuesta:

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

Enviar Única Edición

Entregar Edición Única al contacto especificado.

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

Ejemplo:

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

Respuesta:

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

Enviar Suscripción de la Revista

Entregar suscripción de la revista al contacto especificado.

POST /api/2.0/contacts/<email>/subscription/<magazine_id>
Parámetro Tipo Explicación
cycle int Ciclo de suscripción de la revista. Debe ser enviado solo cuando se entregan suscripciones pagadas. Puede tener uno de los siguientes valores:
  • 1 - para 7 días de suscripción
  • 2 - para 1 mes de suscripción
  • 3 - para 2 meses de suscripción
  • 4 - para 3 meses suscripción
  • 5 - para 6 meses suscripción
  • 6 - para 1 año de suscripción

Ejemplo:

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

Respuesta:

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

Concesión de acceso

Proporcione el acceso al contacto especificado a una edición pagada o cualquier edición que tenga la opción de privacidad establecida en "Solo personas que yo elija"

PUT /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Bandera booleana que indica si el usuario debe ser notificado por correo electrónico o no; debe tener el valor de no o yes

Ejemplo:

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

Respuesta:

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

Revocación de acceso

Revocar el acceso de contactos específicos para aquellas ediciones que se hayan compartido previamente con los mismos de forma manual o mediante campaña

DELETE /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Bandera booleana que indica si el usuario debe ser notificado por correo electrónico o no; debe tener el valor de no o yes

Ejemplo:

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

Respuesta:

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

Eliminar Contacto

Eliminar el contacto solicitado.

DELETE /api/2.0/contacts/<email>

Ejemplo:

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

Respuesta:

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