Documentação da API 2.0 Joomag

Contatos

Obter Lista de Contatos

Devolve lista de contatos da sua conta.

GET /api/2.0/contacts

Exemplo:

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

Resposta:

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

Criar um Contato

Criar um contato na conta

POST /api/2.0/contacts
Parâmetro Tipo Explicação
email String Endereço de e-mail do contato
full_name String Nome completo do contato
country String País do contato
city String Cidade do contato
street String Rua
zip String Código postal do contato

Exemplo:

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

Resposta:

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

Enviar Edição Única

Entregar edição única para o contato especificado.

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

Exemplo:

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

Resposta:

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

Enviar Assinatura da Revista

Entregar assinatura da revista para contato especificado.

POST /api/2.0/contacts/<email>/subscription/<magazine_id>
Parâmetro Tipo Explicação
cycle int Ciclo de assinatura da revista. Deve ser enviado somente ao entregar assinaturas pagas. Pode ter um dos seguintes valores:
  • 1 - para sete dias de assinatura
  • 2 - para 1 mês de assinatura
  • 3 - para 2 meses de assinatura
  • 4 - para 3 meses de assinatura
  • 5 para 6 meses de assinatura
  • 6 para 1 ano de assinatura

Exemplo:

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

Resposta:

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

Concessão de acesso

Fornecer o acesso ao contato especificado para a edição paga ou qualquer edição que tenha a opção de privacidade definida como "Somente pessoas que eu escolha"

PUT /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Bandeira booleana que indica se o usuário deve ser notificado por e-mail ou não; deve ter valor de no ou yes

Exemplo:

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

Resposta:

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

Revogar o acesso

Revogar o acesso de contatos especificados para as edições que foram previamente compartilhadas com os mesmos manualmente ou por meio de campanha.

DELETE /api/2.0/contacts/<email>/access/<issue_id>
notify_user bool Bandeira booleana que indica se o usuário deve ser notificado por e-mail ou não; deve ter valor de no ou yes

Exemplo:

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

Resposta:

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

Excluir Contato

Exclui o contato solicitado

DELETE /api/2.0/contacts/<email>

Exemplo:

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

Resposta:

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