The LogicMelon API can be found at the following URL, with endpoints appended.
https://api.logicmelon.com/JSON/Multiposter.asmx
e.g., https://api.logicmelon.com/JSON/Multiposter.asmx/AddAdvert
Broadly the functionality is split into the following areas:
Management of your LogicMelon account is also available via the API.
https://api.logicmelon.com/JSON/Administration.asmx
Through the endpoints here you have the capability of:
EMEA, APAC VS USA
Depending on your location, your account with LogicMelon will either be under our EMEA, APAC instance or US instance. It is important to determine this, as the API landing pages are different per instance and subsequently so are the end points:
https://api.logicmelon.co.uk/json/Multiposter.asmx
https://api.usa.logicmelon.com/json/multiposter.asmx
Most LogicMelon endpoints require authentication, which usually comprises of an API Key, password, and username. API Keys are tied to organisation structures and give you access to that structure, via your API calls.
The username value will be the username of the user in LogicMelon. This value is particularly important as it provides the context of access or ownership in the targeted LogicMelon structure. For instance, if you are looking to retrieve applications, then only applications which are visible to the username given will be accessible. If you are looking to post an advert, then the advert will be owned by the user of the username provided and created in the organisation structure hierarchy according to where this user resides.
Important
LogicMelon recommends that users created in LogicMelon are created with their email as their username for ease of sync with the parent system for integration.
The password provided can be one of two values. It can either be the specific password linked to the username of the LogicMelon account or you can request a master password, which when set and provided in a payload, will allow access against any username in the organisation structure.
Important
LogicMelon recommends requesting and utilising a master password for integrations. This avoids having to sync user specific passwords across accounts.
Interactive VS Non-Interactive
The most widely used functionality of the API is distributing an advert. To integrate with LogicMelon there are two variations (Interactive and Non-Interactive).
Interactive integration involves providing advert detail in a payload and LogicMelon will return a URL, which can then be opened in a browser. Opening this URL will authenticate and access the LogicMelon posting page with the advert values provided from the payload, where the user then completes the posting process. The URL returned can be constructed as either an iframe URL (simplistic, just showing the posting page) or a full login URL, which on open will initialise the full LogicMelon platform, redirecting to new workstack item for your advert (by default the latter is returned, for the former please raise a ticket request with LogicMelon).
The non-interactive version involves using the API to provide all values for an advert, the destination feeds and delivering the advert, without the LogicMelon UI.
Important
LogicMelon recommends utilising the interactive version for an integration. The non-interactive version will require maintenance as sites change their criteria. Please read below for more detail.
As previously detailed, the Interactive integration option allows distribution of an advert, providing as many values as desired via the initial payload. Should you wish to update the advert content then supply an sAdvertID (The LogicMelon AdvertID returned after initial creation) value or the same sAdvertReference or sAdvertIdentifier values used in the initial creation.
The API process flow is detailed below:
Call API endpoint AddAdvert to create your advert
https://api.logicmelon.com/json/multiposter.asmx?op=AddAdvert
Open the URL returned in the response in a browser where you’ll be authenticated and redirected to your advert to complete the posting process.
The non-interactive style integration requires that you provide all the job data required for your chosen sites per advert, following up with an advert delivery request via the API. This means your users will not use the LogicMelon posting pages to complete any missing information. To this end, depending on the sites selected, the data needed for a successful delivery will change.
If you are selecting the non-interactive integration, this will involve a lot more support, maintenance, and data requirements longer term. Sites change their features, where the integration need to be adjusted.
The API process flow is detailed below:
Push the job with all associated data to https://api.logicmelon.com/json/multiposter.asmx?op=AddAdvert
Validate the data against the job against the sites you want to post to https://api.logicmelon.com/json/multiposter.asmx?op=ValidateAdvertValues
If no failures are returned, ask the LogicMelon servers to deliver the advert https://api.logicmelon.com/json/multiposter.asmx?op=DeliverAdvert
If failures are returned, lookup the effected fields (detailed below) and their accepted values, return to step one of this process and provide the additional data against the advert in question and continue the subsequent API calls until accepted.
Postman Examples
See link below for Video demonstrating API distribution for both Interactive and non-interactive variations as well as an exported Postman (https://www.postman.com/) collection of API calls made in the demonstration video:
Non-interactive demo postman collection
For utilising either the interactive or non-interactive version, you may want to delve further into the additional fields which can be provided in Advert creation. You may also wish to determine a list of sites, which LogicMelon support posting to. Below are listed some of URLs to retrieve this data.
List supported site destinations for posting:
https://xml.logicmelon.com/?External=LookUp&DataItem=feed
List a subset of supported site destinations for posting:
List all fields which are currently supported:
https://xml.logicmelon.com/?External=LookUp&DataItem=field&fieldID=15
List fields for a particular site destination:
List accepted field values for a particular field (example here is field 15):
https://xml.logicmelon.com/?External=LookUp&DataItem=fieldvalue&FieldID=15
In terms of retrieving data and to keep it simple LogicMelon has created URLs that return xml. Our recommendation is to download and cache this data in your own tables where you can refresh daily or weekly for changes.
List location data (example here is for UK):
https://xml.logicmelon.com/?External=LookUp&DataItem=location&LocationValue=GB&stylesheet=none
Applications with the API can be broken into two variants, 180 integration or 360 integrations.
A 180 integration is where you provide LogicMelon with the landing page for applications through the AddAdvert payload (sApplicationURL value). LogicMelon will then distribute this to your selected sites where applications will subsequently circumvent LogicMelon and come directly to you.
A 360 integration is where LogicMelon handles applications for you. By not providing an applicationURL, applications will flow into LogicMelon. To receive these applications, you have the following options:
Poll for applications via the GetApplications endpoint.
Include an advert specific callback on AddAdvert
Provide LogicMelon with a target mailbox with parsing capabilities.
Important
Advert specific callback is only available for adverts created through the LogicMelon API. In addition, alert LogicMelon, as it requires to enabling the specific account.
If you are an existing customer, this option may conflict your current settings. Contact us for clarification.
Simplistically, poll our endpoint GetApplications providing a start and end time range for applications.
Important
LogicMelon recommend that you restrict your date range to just one day of applications. In addition, depending on the size of your organisation structure, you should also look to reduce the performance overhead by targeting specific levels of that organisation structure through the sStartOrganisation value or by targeting specific adverts through the sAdvertID value.
When calling AddAdvert you can provide an advert specific callback URL through the value sApplicationCallbackURL. In doing so, LogicMelon will subsequently call this URL when an application is received and provide the LogicMelon applicationID:
Subsequently you can provide a call to the GetApplications endpoint, targeting the specific application to return, utilising the AdvertCandidateIDAsCSV value.
Important
Utilising this application variation requires that LogicMelon are notified as it requires configuration against your account to enable.
If you have a parsing engine, then LogicMelon can forward all applications once they are received, onto the given inbox for parsing.
Important
Utilising this application variation requires that LogicMelon are notified as it requires configuration against your account to enable.
Postman Examples
Exported Postman (https://www.postman.com/) API call for GetApplications
getApplications demo postman collection