API של המערכת

ה-API של המערכת מבוסס על HTTP POST פשוט.

 

במערכת קיימות כרגע 4 מתודות.

 

משיקולי נוחות מאמר זה כתוב באנגלית.

 

Subscribe

This method adds a new subscriber to a list. You can also use this method to update an existing subscriber.

 

URL

http://your_url/subscribe

 

Parametetrs (post)

  1. name user's name is optional
  2. email user's email
  3. list the list id you want to subscribe a user to. This encrypted & hashed id can be found on the list's main page
    under מספר זיהוי - ID
  4. boolean set this to "true" so that you'll get a plain text response

Response (plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

Error: Invalid list ID.

Error: Already subscribed.

 

Unsubscribe

This method unsubscribes a user from a list.

http://your_url/unsubscribe

 

Parameters (Post)

  1. email user's email
  2. list the list id you want to unsubscribe a user from. This encrypted & hashed id can be found  on the list's main page
    under מספר זיהוי - ID
  3. boolean set this to "true" so that you'll get a plain text response

Response (plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

 

Subscription status

URL

http://your_url/api/subscribers/subscription-status.php

 

Parameters (Post)

 

  1. api_key your API key (we will send you the key)
  2. email user's email
  3. list_id the id of the list this email belongs to. This encrypted id can be found  on the list's main page
    under מספר זיהוי - ID

Response (plain text)

Success: Subscribed

Success: Unsubscribed

Success: Unconfirmed

Success: Bounced

Success: Soft bounced

Success: Complained

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: Email not passed

Error: List ID not passed

Error: Email does not exist in list

 

Active subscriber count

This method gets the total active subscriber count.

 

URL

http://your_url/api/subscribers/active-subscriber-count.php

 

Parameters (Post)

 

  1. api_key your API key (we will send you the key)
  2. list_id the id of the list you want to get the active subscriber count. This encrypted id can be found on the list's main page
    under 
    מספר זיהוי - ID

Response (plain text)

Success: You'll get an integer of the active subscriber count

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: List ID not passed

Error: List does not exist