ה-API של המערכת מבוסס על HTTP POST פשוט.
במערכת קיימות כרגע 4 מתודות.
משיקולי נוחות מאמר זה כתוב באנגלית.
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)
name
user's name is optionalemail
user's emaillist
the list id you want to subscribe a user to. This encrypted & hashed id can be found on the list's main pageboolean
set this to "true" so that you'll get a plain text responseResponse (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)
email
user's emaillist
the list id you want to unsubscribe a user from. This encrypted & hashed id can be found on the list's main pageboolean
set this to "true" so that you'll get a plain text responseResponse (plain text)
Success: true
Error: Some fields are missing.
Error: Invalid email address.
URL
http://your_url/api/subscribers/subscription-status.php
Parameters (Post)
api_key
your API key (we will send you the key)email
user's emaillist_id
the id of the list this email belongs to. This encrypted id can be found on the list's main pageResponse (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
This method gets the total active subscriber count.
URL
http://your_url/api/subscribers/active-subscriber-count.php
Parameters (Post)
api_key
your API key (we will send you the key)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 pageResponse (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