API: Examples
This document provides a guide for software developers to use the Archiver REST API.
The following code examples will demonstrate calls against the Archiver REST API using the Python programming language. The only dependency is the Requests REST client library (http://docs.python-requests.org/en/master/). You can run commands similar to the following (substituting your own email/password) from the Python REPL.
Authenticating
import requests
url = "https://archiver.sageflo.com/api/v1/login"
payload = {"email": "youraccount@email.com", "password": "yourpassword"}
auth_response = requests.post(url, json=payload)
auth_response.json()
{
"issued_at": "2020-01-01T01:28:16.852Z",
"auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiYWNjb3VudF9pZCI6MSwiZW1haWwiO iJ0aG9tYXNAbGlmdHNjaWVuY2UuaW8iLCJmaXJzdF9uYW1lIjoiVGhvbWFzIiwibGFzdF9uYW1lIjoi V2VzdGNvdHQiLCJyb2xlIjpbIlNVUEVSX0FETUlOIl0sImlhdCI6MTQ2NDA1MzI5NiwiZXhwIjoxNDY 0MDgyMDk2fQ.nesnjLlNnvCa7N_rWrzNtAy20OkC_cB2f-G1E-9VpTU"
}
Searching for Emails
payload = {"email": "user@sageflo.com", "start_date": "11/26/2019", "end_date": "1/1/2020"}
url = "https://archiver.sageflo.com/api/v1/email/search"
headers = {"Authorization": auth_response.json()["auth_token"]}
response = requests.post(url, headers=headers, json=payload)
response.json()
{
"results": [
{
"campaign_name": "WarmupAOL",
"campaign_purpose": "PROMOTIONAL",
"email": "user@sageflo.com",
"from_email": "store-news@store.com",
"from_name": "Store.com",
"is_campaign_avail": true,
"locator": "bGlmdHNjaWVuY2UudGVzdC5idWNrZXR8fDIwMTYwMjE1LWRlbW8tZW1haWxzfHwyMDI1N3x8MjYyMjI=",
"email_url": "https:/archiver.sageflo.com/api/v1/email/bGlmdHNjaWVuY2UudGVzdC5idWNrZXR8fDIwMTYwMjE1LWR lbW8tZW1haWxzfHwyMDI1N3x8MjYyMjI=",
"marketing_program": null,
"marketing_strategy": null,
"platform_campaign_id": 1342,
"sent_dt": "2019-12-04T08:00:00.000Z",
"sub_account_id": null,
"subject": "Last Few Days to Enter"
},
{
"campaign_name": "WarmupGmail",
"campaign_purpose": "PROMOTIONAL",
"email": "user@sageflo.com",
"from_email": "sender@sender.com",
"from_name": "Daily Deals",
"is_campaign_avail": true,
"locator": "bGlmdHNjaWVuY2UudGVzdC5idWNrZXR8fDIwMTYwMjE1LWRlbW8tZW1haWxzfHwxOTA5MTJ8fDE5NTgxMg==",
"email_url": "https://archiver.sageflo.com/api/v1/email/\nbGlmdHNjaWVuY2UudGVzdC5idWNrZXR8fDIwMTYwMjE1LWRlbW8tZW1haWxzfHwxOTA5MTJ8fDE5NTgxMg==",
"marketing_program": null,
"marketing_strategy": null,
"platform_campaign_id": 1402,
"sent_dt": "2015-12-04T08:00:00.000Z",
"sub_account_id": null,
"subject": "Cyber Flash Sale - save 30% sitewide!"
}
]
}
Retrieving Email Contents
url = "https://archiver.sageflo.com/api/v1/email/GlmdHNjaWVuY2UudGVzdC5idWNrZXR8fDIwMTYwMjE 1LWRlbW8tZW1haWxzfHwxOTA5MTJ8fDE5NTgxMg=="
headers = {"Authorization": auth_response.json()["auth_token"]}
response = requests.get(url, headers=headers)
response.text
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html
xmlns="http://www.w3.org/1999/xhtml"><head>\n<meta http-equiv="Content-Type"
content="text/html; charset=utf-8">\n<meta name="viewport" content="width=device-
width, initial-scale=1.0, maximum-scale=1.0, user-scalable=false">
\n\n<title>Hurry! Cyber Savings will be gone in a flash!</title>\n<style
type="text/css">\n*{-webkit-text-size-adjust:none;-ms-text-size-adjust:none;}\n@-
ms-viewport{ width: device-width; }\n/*DESKTOP RESETS*/\nul{\n list-s" etc...
Resending an Email
url = "https://archiver.sageflo.com/api/v1/email/send"
headers = {"Authorization": auth_response.json()["auth_token"]}
payload = {"locator": "bGlmdHNjaWVuY2UudGVzdC5idWNrZXR8fDIwMTYwMjE1LWRlbW8tZW1haWxzfHwxOTA5MTJ8fDE5NTgxMg== ", "email": "user@sageflo.com", "subject": "RESEND: Big Savings!"}
response = requests.post(url, headers=headers, json=payload)
response
<Response [200]>
response.json()
{"message": "Email Sent Successfully"}