Getting Started

The SmartFile API allows programmers to create automated interfaces that can pass files and information directly into the SendMyAd and Virtual Publisher portals without user intervention. This API is based on a REST interface that accepts commands via HTTP POST variables.

To get started using the API a few things are required:

1. Request an API key. API keys can be received via a request to the SendMyAd staff.
2. Identify the publisher code you wish to send files to. If you're a publisher, this can be seen within your company profile. Otherwise, submit a request to the SendMyAd staff.
3. You will need the ability to make an HTTP POST with required variables & follow case sensitivity naming conventions. This can be done in most languages.
4. It is also preferable that you have the ability to parse XML and/or JSON responses, since this is the native result of all API calls. Without it, you may not know your results.

Download our SmartFile API Postman collection and try it out!

To use: download and unzip the archive. In Postman, import both our collection and environment files. Fill in your information (publisher code, API key, etc.) in the environment variables and run the examples.

Examples

Below is an example of how to return a list of issues for a publication. We recommend using the cURL command line application for testing, because it will accurately display the responses in your terminal. (Note: SendMyAd does not supply example code in specific programming languages)

Request Example via cURL POST

curl -v -3 https://yourpublishername.sendmyad.com/SmartFile/api.php -F apiKey=12345678  -F action=getIssueList -F className=Issue -F publisherCode=XYZ  -F publicationName="Testing Publication"

Alternatively, you can simply create a GET style URL and run in a browser. However, various browsers and versions will handle the response differently. If the XML or JSON response does not display properly, try another browser or use cURL instead.

Request Example via URL

https://yourpublishername.sendmyad.com/SmartFile/api.php?apiKey=12345678&action=getIssueList&className=Issue&publisherCode=XYZ&publicationName=Testing%20Publication

POST Example via HTML Form

                        
                        <!-- POST AN AD FILE THROUGH HTML FORM -->
                        <form method="post" action="https://portal.sendmyad.com/SmartFile/api.php" enctype="multipart/form-data">
                            <input type="file" id="upfile_0" name="upfile_0"  value="">
                            <input type="hidden" id="action" name="action" value="uploadAd" />
                            <input type="hidden" id="className" name="className" value="Upload" />
                            Key:
                            <input type="text" id="apiKey" class="w120" name="apiKey" value="[YOURKEY]" />
                            PublisherCode:
                            <input type="text" id="publisherCode" name="publisherCode" value="[YOURDATA]" />
                            PublicationCode:
                            <input type="text" id="publicationCode" name="publicationCode" value="[YOURDATA]" />
                            IssueCode:
                            <input type="text" id="issueCode" name="issueCode" value="[YOURDATA]" />
                            AdSpecCode:
                            <input type="text" id="adSpecCode" name="adSpecCode" value="[YOURDATA]" />
                            colorProfileShortLabel:
                            <input type="text" id="colorProfileCode" name="colorProfileCode" value="[YOURDATA]" />
                            <input type="submit" class="btn" name="mysubmit" value="Upload">
                        </form>

                        <!-- RESERVE AN AD SPACE -->
                        <form method="post" action="https://portal.sendmyad.com/SmartFile/api.php" enctype="multipart/form-data">
                            <input type="hidden" id="action" name="action" value="reserveAdSpace" />
                            <input type="hidden" id="className" name="className" value="Reservation" />
                            <input type="hidden" id="responseFormat" name="responseFormat" value="JSON" />
                            Publisher Code:
                            <input type="text" id="publisherCode" name="publisherCode" value="[YOURDATA]" />
                            API Key: 
                            <input type="text" id="apiKey" name="apiKey" value="[YOURKEY]" />
                            Publication Code:
                            <input type="text" id="publicationCode" name="publicationCode" value="[YOURDATA]" />
                            Ad Spec Code:
                            <input type="text" id="adSpecCode" name="adSpecCode" value="[YOURDATA]" />
                            Issue Code:
                            <input type="text" id="issueCode" name="issueCode" value="[YOURDATA]" />
                            Color Profile Name:
                            <input type="text" id="colorProfileName" name="colorProfileName" value="[YOURDATA]" />
                            Label:
                            <input type="text" id="label" name="label" value="API TEST AD" />
                            Credit Hold:
                            <input type="text" id="creditStatus" name="creditStatus" value="0" />
                            Ad Instructions:
                            <input type="text" id="adInstructions" name="adInstructions" value="lorem ipsum..." />
                            <input type="submit" class="btn" name="mysubmit" value="Send">
                        </form>
                        
                    

The Upload Class

The upload class contains all of the functions needed to post a file to SendMyAd and Virtual Publisher.

Guidelines

• File posting is limited to no more than 100mb per file
• Files must be uploaded 1 at a time
• To post a file, your form must employ the method POST, GET will not work and type of multipart/form-data.
• Your file form variable must be named upload_0
• The api supports PDF only. Each PDF must have a valid embedded xmp job ticket. Supported job ticket formats are GWG Ad Ticket and SMA Job Ticket format.

Available Actions

                                    
                                    <results>
                                        <success>true/false</success>
                                        <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                        <processId>A unique string which represents the ad.</processId>
                                    </results>
                                    
                                

                                    
                                    <results>
                                        <success>true/false</success>
                                        <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                        <processId>A unique string which represents the ad.</processId>
                                    </results>
                                    
                                

The Reservation Class

This class contains ways to create reservations in the system.

Available Actions

                                    
                                    <results>
                                        <success>true/false</success>
                                        <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                        <processId>A unique string which represents the ad.</processId>
                                    </results>
                                    
                                

                                    
                                    <results>
                                        <success>true/false</success>
                                        <error>Upload failed. Please try again.</error>
                                        <processId>A unique string which represents the ad.</processId>
                                    </results>
                                    
                                

                                    
                                    {"success":1,"msg":"Advertiser contact changed successfully"}
                                    
                                

The Message Class

This class contains all of the functions needed to send messages related the SendMyAd Portal

Available Actions

                                    
                                         <results>
                                            <success>true/false</success>
                                            <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                            <emailsSentCount>The number of emails successfully sent out.</emailsSentCount>
                                        </results>
                                    
                                

                                    
                                    {"success":1,"msg":"Notification scheduled for Print Ad processId 202373193332075"}
                                    
                                

The User Class

This class contains functions related to SendMyAd users.

Available Actions

                                    
                                         <results>
                                            <success>true/false</success>
                                            <userId>the id of the newly created user.</userId>
                                            <msg>Any response message.</msg>
                                        </results>
                                    
                                

                                    
                                        <results>
                                            <success>true/false</success>
                                            <userId>the id of the newly created user.</userId>
                                            <msg>Any response message.</msg>
                                        </results>
                                    
                                

                                    
                                        <results>
                                            <success>true/false</success>
                                            <userId>the id of the newly created user.</userId>
                                            <msg>Any response message.</msg>
                                        </results>
                                    
                                

                                    
                                        {"success":1,"msg":"", "userId":"123"}
                                    
                                

                                    
                                        {"success":1,"msg":"", "userId":"123"}
                                    
                                

                                    
                                        {"success":1,"msg":"", "userId":"123"}
                                    
                                

The Ad Class

This class contains ways to get and update ad information in the system.

Available Actions

                                    
                                        {"success":"1","msg":"","data":{"key1":"value1","key2":"value2",...}
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "rowCount":16,
                                            "data":{
                                                "123455":{
                                                    "processId":"12342314",
                                                    "fileName":"my.pdf",
                                                    "publicationName":"My Publication",
                                                },
                                                ...
                                            }
                                        }
                                    
                                

                                    
                                        {"success":"1","msg":"","data":{"key1":"value1","key2":"value2",...}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":"","issueId":1234}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":""}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":""}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":"","data":[{"id":"150","name":"Materials Ok"},{...}]}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":"","status":"statusId"}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":"","linkToAsset":"https://<LINK_TO_ASSET>"}
                                    
                                

                                    
                                        {"success":"0 | 1","msg":""}
                                    
                                

The DigitalAd Class

This class contains ways to create digital ad reservations in the system.

Available Actions

                                    
                                        <results>
                                            <success>true/false</success>
                                            <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                            <processId>A unique string which represents the ad.</processId>
                                        </results>
                                    
                                

                                    
                                        {"success":"1","msg":"","data":{"key1":"value1","key2":"value2",...}
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "rowCount":4,
                                            "data":{
                                                "123455":{
                                                    "processId":"12342314",
                                                    "fileName":"my.jpg",
                                                    "mediaProfileName":"My Media Profile",
                                                },
                                                ...
                                            }
                                        }
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "rowCount":1,
                                            "data":{
                                                "568":{
                                                    "mediaProfileId":"568",
                                                    "publisherName":"Example Publisher",
                                                    ...
                                                }
                                            }
                                        }
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "rowCount":10,
                                            "data":{
                                                "123":{
                                                    "id":"123",
                                                    "adSpecName":"3:1 Rectangle",
													"width":"300",
													"height":"100",
                                                    ...
                                                }
                                            }
                                        }
                                    
                                

                                    
                                         <results>
                                            <success>true/false</success>
                                            <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                            <emailsSentCount>The number of emails successfully sent out.</emailsSentCount>
                                        </results>
                                    
                                

                                    
                                        {
                                            "success": 1,
                                            "msg": "List of all assigned run dates",
                                            "data": [
                                                {
                                                    "id": "1945",
                                                    "runFrom": "2023-03-23 00:00:00",
                                                    "runTo": "2023-04-23 00:00:00"
                                                },
                                                {
                                                    "id": "1946",
                                                    "runFrom": "2023-02-23 00:00:00",
                                                    "runTo": "2023-03-23 00:00:00"
                                                },
                                                ...
                                            ]
                                        }
                                    
                                

                                    
                                        {
                                            "success": 1,
                                            "msg": "Run dates assigned successfully",
                                            "data": [
                                                {
                                                    "id": "1962",
                                                    "runFrom": "2023-03-23 00:00:00",
                                                    "runTo": "2023-04-23 00:00:00"
                                                },
                                                {
                                                    "id": "1961",
                                                    "runFrom": "2023-03-23 00:00:00",
                                                    "runTo": "2023-04-23 00:00:00"
                                                }
                                            ]
                                        }
                                    
                                

                                    
                                        {"success":1,"msg":"Run date cancelled successfully"}
                                    
                                

                                    
                                        {"success":1,"msg":"Values for fieldName1, fieldName2,... fields updated for ad processId."}
                                    
                                

                                    
                                        {
                                            "success":1,"msg":"",
                                            "assets":[
                                                {
                                                    "label":"Original File",
                                                    "linkToAsset":"https://<LINK_TO_ASSET>",
                                                    "type":"<ASSET_TYPE>"
                                                },
                                                {
                                                    "label":"Preview File",
                                                    "linkToAsset":"https://<LINK_TO_ASSET>",
                                                    "type":"<ASSET_TYPE>"
                                                }
                                            ]
                                        }                                        
                                    
                                

The AdCreator Class

This class contains ways to create Ad Creator reservations in the system.

Available Actions

                                    
                                        <results>
                                            <success>true/false</success>
                                            <error>Each error that occurred as a text description. Each error will generate a new xml error tag.</error>
                                            <processId>A unique string which represents the ad.</processId>
                                        </results>
                                    
                                

The AdSpec Class

This class contains ways to get ad specification (size) information in the system.

Available Actions

                                    
                                         {
                                            "success":1,
                                            "rowCount":16,
                                            "data":{
                                                "216":{
                                                    "adSpecId":"216",
                                                    "adSpecName":"Full Page",
                                                    "adSpecCode":"FP",
                                                    ...
                                        }
                                    
                                

                                    
                                         {
                                            "success":1,
                                            "rowCount":16,
                                            "data":{
                                                "216":{
                                                    "adSpecId":"216",
                                                    "adSpecName":"Full Page",
                                                    "adSpecCode":"FP",
                                                    ...
                                        }
                                    
                                

The Company Class

This class contains ways to create advertiser and agency companies associated with a publisher.

Available Actions

                                    
                                         {"success":1,"msg":""}
                                    
                                

                                    
                                         {"success":1,"msg":""}
                                    
                                

                                    
                                         {"success":1,"msg":""}
                                    
                                

                                    
                                         {"success":1,"msg":"", "companyId":"123"}
                                    
                                

                                    
                                         {
                                             "success":1,
                                             "rowCount":4,
                                             "data":{
                                                 ["advertiserId":"411","advertiserName": ...]
                                             }
                                        }
                                    
                                

                                    
                                         {
                                             "success":1,
                                             "rowCount":3,
                                             "data":{
                                                 ["agency":"436","agencyName": ...]
                                             }
                                        }
                                    
                                

The Publisher Class

This class contains ways to find information specific to a publisher.

Available Actions

                                    
                                        {
                                            "success":1,
                                            "rowCount":3,
                                            "data":{
                                                "2":{"name":"House Ad","code":"","description":"","publisherId":"0","id":"2"},
                                                "3":{"name":"PSA","code":"","description":"","publisherId":"0","id":"3"},
                                                "1":{"name":"Supplied Ad","code":"","description":"","publisherId":"0","id":"1"}
                                            }
                                        }
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "id":4,
                                            "msg":"Ad type added successfully."
                                        }
                                    
                                

The Issue Class

This class contains ways to find information about and add new issues.

Available Actions

                                    
                                         {"success":1,"id":2437}
                                    
                                

                                    
                                         {"success":1,"exists":"0 | 1"}
                                    
                                

                                    
                                         {
                                             "success":1,
                                             "data":{
                                                 "issueId":"2436",
                                                 "issueCode":"",
                                                 "runDate":"2014-06-16 00:00:00",
                                                 ...
                                            }
                                         }
                                    
                                

                                    
                                         {
                                             "success":1,
                                             "rowCount":4,
                                             "data":{
                                                 "1621":{
                                                     "issueId":"1621",
                                                     "issueName":"2015",
                                                     "issueCode":"ISS2015",
                                                     "runDate":"2014-12-19 00:00:00",
                                                     ...
                                                    }
                                             }
                                         }
                                    
                                

                                    
                                         {"success":1,"msg":"Updated issue successfully."}
                                    
                                

The Publication Class

This class contains ways to find information about publications.

Available Actions

                                    
                                        {
                                            "success":1,
                                            "rowCount":7,
                                            "data":{
                                                "155":{
                                                    "publicationId":"155",
                                                    "publicationName":"Testing Magazine",
                                                    ...
                                                }
                                            }
                                        }
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "rowCount":3,
                                            "data":{
                                                "247":{
                                                    "colorProfileId":"247",
                                                    "colorProfileName":"all warnings",
                                                    ...
                                                }
                                            }
                                        }
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "rowCount":3,
                                            "data":{
                                                "247":{
                                                    "colorProfileId":"247",
                                                    "colorProfileName":"all warnings",
                                                    ...
                                                }
                                            }
                                        }
                                    
                                

                                    
                                        {"success":1,"rowCount":5,"data":{"2":{"sectionId":"2",...}}
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "id":809,
                                            "msg":"Ad Category added successfully."
                                        }
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "id":49,
                                            "msg":"Publication section added successfully."
                                        }
                                    
                                

                                    
                                        {"success":1,"rowCount":5,"data":{"45":{"tagId":"45",...}}
                                    
                                

                                    
                                        {"success":1,"tagId":342,"msg":"Position tag added successfully."}
                                    
                                

                                    
                                        {
                                            "success":1,
                                            "msg":"Position tag 342 edited successfully."
                                        }