The REST API lets you interact directly with Press Loft from anything that can send an HTTP request. All API access must use HTTPS.
\nThe primary host is https://api.pressloft.com/v1.
The entire API uses JSON encoded as UTF-8.
\nThe body of POST and PUT requests must be either a JSON object or a JSON array (depending on the particular endpoint) and the Content-Type header should be set to application/json; charset=UTF-8.
The body of responses is always a JSON object, and the Content-Type is always application/json; charset=UTF-8.
Unless otherwise stated, parameters must be passed:
\nParameters passed in the URL must be properly URL-encoded, using the UTF-8 encoding for non-ASCII characters.
\nTo authenticate your API requests, add these headers:
\nx-api-key: the application keyx-api-secret: the application secretTo create these credentials log into your Press Loft account.
\nNot all endpoints are available to all account types. Currently the API is only available to registered brand accounts and registered publisher accounts. Below is a summary of which enpoints are available to each account type.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20294542","collectionId":"34d3f90c-7395-4740-b4b9-534f78127c89","publishedId":"2s93RZM9wx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"A647A7"},"publishDate":"2023-05-22T16:11:15.000Z"},"item":[{"name":"Product Library","item":[{"name":"Get all products","id":"75b00872-4a7c-4451-9012-e5fef958be74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-secret","value":"{{apiSecret}}","type":"text"}],"url":"https://api.pressloft.com/v1/products?page-size={{integer}}&page-number={{integer}}&sort={{string}}","description":"Returns a list of all products in your library. Results are paginated.
\nReturns a single product from your library.
\nAdd a single product to your library.
\nThe body must be a JSON object and the Content-Type header must be set to application/json; charset=UTF-8.
The response is a JSON object.
\n","urlObject":{"path":["products"],"host":["https://api.pressloft.com/v1"],"query":[],"variable":[]}},"response":[{"id":"373f86ab-1c59-47fb-9c98-3dd3304f524f","name":"success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Update a single product in your library.
\nThe body must be a JSON object and the Content-Type header must be set to application/json; charset=UTF-8.
Delete a single product in your library.
\nThe /product enpoint is for all operations to manage your Press Loft product library.
Authorised access to: registered brand accounts only.
\nProvides a full list of all Press Loft categories.
\nAuthorised access to: registered brand accounts and registered publisher accounts.
\n","_postman_id":"3049c419-e298-49f2-8228-7f549df4a217"},{"name":"Affiliate Brands","item":[{"name":"Get all affiliate brands","id":"53b8a027-351f-48d4-a7d8-46af46e82ab0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-secret","value":"{{apiSecret}}","type":"text"}],"url":"https://api.pressloft.com/v1/affiliates?page-size={{integer}}&page-number={{integer}}&sort={{string}}","description":"Returns a list of all affiliate brands. Results are paginated.
\nReturns a single affiliate brand.
\nProvides a full list of all Press Loft affiliate brands.
\nAuthorised access to: registered publisher accounts.
\n","_postman_id":"51d7faee-3faf-469c-bbce-fab577b10617"},{"name":"Sale Commissions","item":[{"name":"Get all sale commissions","id":"3a8f0ade-0bb0-4187-b540-45c51e599c49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-secret","value":"{{apiSecret}}","type":"text"}],"url":"https://api.pressloft.com/v1/commissions?page-size={{integer}}&page-number={{integer}}&sort={{string}}&start-date={{date}}&end-date={{date}}","description":"Returns a list of all sale commissions. Results are paginated.
\nYYYY-MM-DD
\n","type":"text/plain"},"key":"start-date","value":"{{date}}"},{"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"end-date","value":"{{date}}"}],"variable":[]}},"response":[{"id":"a9e46006-a02f-42ad-9132-fa3dfce9f3ee","name":"success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Returns a list of all sale commissions related to a single affiliate. Results are paginated.
\nYYYY-MM-DD
\n","type":"text/plain"},"key":"start-date","value":"{{date}}"},{"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"end-date","value":"{{date}}"}],"variable":[]}},"response":[{"id":"59981052-0383-49eb-b43d-2ecef3d24958","name":"success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Returns a list of all sale commissions in a receipt. Results are paginated.
\nYYYY-MM-DD
\n","type":"text/plain"},"key":"start-date","value":"{{date}}"},{"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"end-date","value":"{{date}}"}],"variable":[]}},"response":[{"id":"c301ad56-feab-4232-a176-dea1c59fa0d2","name":"success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Returns a single sales commission.
\nProvides a full list of all sale commissions.
\nAuthorised access to: registered publisher accounts.
\n","_postman_id":"a7e11d38-d3b7-44d1-9aaa-87e1a43faef6"},{"name":"Payout Receipts","item":[{"name":"Get all payout receipts","id":"ce22d58b-9cb2-40f3-ac08-57bf51cd846c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-secret","value":"{{apiSecret}}","type":"text"}],"url":"https://api.pressloft.com/v1/receipts?page-size={{integer}}&page-number={{integer}}&sort={{string}}","description":"Returns a list of all payout receipts. Results are paginated.
\nReturns a single payout receipt.
\nProvides a full list of all receipts for sales commission payouts.
\nAuthorised access to: registered publisher accounts.
\n","_postman_id":"e3671a51-1e0b-44bc-8bb4-3bd9fe5166c7"}],"event":[{"listen":"prerequest","script":{"id":"d9b24838-bbd5-4b37-9054-b4b7b4b74dfd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"50668d0b-317b-4c58-97a4-5ef9639d922f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"basePath","value":"v1"},{"key":"baseUrl","value":"https://api.pressloft.com/v1"}]}