PFL.PFLLink.AppCenter.API
API change historyPrintingForLess.com Generic API for accessing PFL Stores. Through the API, you can view products of associated stores, receive price quotes, submit fulfillment/print orders, and receive Order Status events.
Webhook [List App]: /application/{applicationID}/webhook
Search for all webhooks being used by a given application
Required Permissions:
- Application 'admin' Can not be used by applications
Request
Request URL
Request parameters
-
string
ID of the application
-
(optional)number
Pagination controls, which page to return
-
(optional)number
Pagination controls, how many results to return
Request headers
-
stringOAuth 2.0 access token obtained from PFLlink AppCenter Authorization Server. Supported grant types: Authorization code.
Request body
Responses
200 OK
Representations
{
"PageIndex": 1,
"PageSize": 2,
"TotalCount": 3,
"TotalPageCount": 4,
"HasNextPage": true,
"HasPrevPage": true,
"Items": [
{
"LastNotify": "2016-08-16T04:16:46.6368303+00:00",
"LastError": "2016-08-16T04:16:46.6368303+00:00",
"ConcurrentErrorCount": 1,
"CreatedByID": 2,
"UpdatedByID": 1,
"Created": "2016-08-16T04:16:46.6368303+00:00",
"Updated": "2016-08-16T04:16:46.6368303+00:00",
"ID": "sample string 5",
"ApplicationID": "sample string 6",
"StoreID": "sample string 7",
"Secret": "sample string 8",
"Type": 0,
"Description": "sample string 9",
"HttpMethod": "sample string 10",
"IncludePayload": true,
"URL": "sample string 11",
"Enabled": true,
"DisabledReason": "sample string 12",
"DisableFailureThreashold": 1,
"WarningFailureThreashold": 1,
"RetryDelay": 1
},
{
"LastNotify": "2016-08-16T04:16:46.6368303+00:00",
"LastError": "2016-08-16T04:16:46.6368303+00:00",
"ConcurrentErrorCount": 1,
"CreatedByID": 2,
"UpdatedByID": 1,
"Created": "2016-08-16T04:16:46.6368303+00:00",
"Updated": "2016-08-16T04:16:46.6368303+00:00",
"ID": "sample string 5",
"ApplicationID": "sample string 6",
"StoreID": "sample string 7",
"Secret": "sample string 8",
"Type": 0,
"Description": "sample string 9",
"HttpMethod": "sample string 10",
"IncludePayload": true,
"URL": "sample string 11",
"Enabled": true,
"DisabledReason": "sample string 12",
"DisableFailureThreashold": 1,
"WarningFailureThreashold": 1,
"RetryDelay": 1
}
]
}Code samples
@ECHO OFF
curl -v -X GET "https://pflapi.com/api/v1/application/{applicationID}/webhook?page={number}&take={number}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["page"] = "{number}";
queryString["take"] = "{number}";
var uri = "https://pflapi.com/api/v1/application/{applicationID}/webhook?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://pflapi.com/api/v1/application/{applicationID}/webhook");
builder.setParameter("page", "{number}");
builder.setParameter("take", "{number}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"page": "{number}",
"take": "{number}",
};
$.ajax({
url: "https://pflapi.com/api/v1/application/{applicationID}/webhook?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://pflapi.com/api/v1/application/{applicationID}/webhook";
NSArray* array = @[
// Request parameters
@"entities=true",
@"page={number}",
@"take={number}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://pflapi.com/api/v1/application/{applicationID}/webhook');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'page' => '{number}',
'take' => '{number}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'page': '{number}',
'take': '{number}',
})
try:
conn = httplib.HTTPSConnection('pflapi.com')
conn.request("GET", "/api/v1/application/{applicationID}/webhook?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'page': '{number}',
'take': '{number}',
})
try:
conn = http.client.HTTPSConnection('pflapi.com')
conn.request("GET", "/api/v1/application/{applicationID}/webhook?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://pflapi.com/api/v1/application/{applicationID}/webhook')
query = URI.encode_www_form({
# Request parameters
'page' => '{number}',
'take' => '{number}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body