External System and Integration APIs

KB Home   |   External System and Integration APIs

Main.ExternalDataSourceAPI History

Hide minor edits - Show changes to output

Added line 113:
* [[https://www.papercut.com/solutions/product-integrations/|Full list of 3rd Party Integrations]].
July 25, 2017, at 03:08 AM by Alec - Add link to custom auth KB article -- much more useful that info in manual
Changed line 38 from:
Organizations wishing to replace PaperCut's LDAP/AD/eDiretory/`OpenDirectory user direction support with a custom user directory provide may do so using a ''Custom User Information Directory Provider''.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in [[https://www.papercut.com/products/ng/manual/ch-customization-user-provider.html|Chapter 16]] in the PaperCut manual.
to:
Organizations wishing to replace PaperCut's LDAP/AD/eDiretory/`OpenDirectory user direction support with a custom user directory provide may do so using a ''Custom User Information Directory Provider''.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in our [[https://www.papercut.com/kb/Main/CaseStudyCustomUserSyncIntegration|case study]].
July 25, 2017, at 02:54 AM by Alec - Add link to the GitHub repo
Added lines 24-25:

You can find some examples in our `GitHub [[https://github.com/PaperCutSoftware/PaperCutExamples/tree/master/PublicWebServicesAPI_AND_servercommandScripts|repository]].
September 28, 2015, at 03:53 AM by Alec - Deprecated the External Account API
Changed lines 86-91 from:
The ''External Account Source'' API allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time). 

The External Account Source API is a complex topic!  The
PaperCut Software Development Team is happy to provide documentation and work with system integrators to find the best solutions.  Implementers should take considerable care in development and integration as implementations effectively replace PaperCut's account database so any failures will extend through all layers of the system.  (A buggy implementation will take down PaperCut!)

'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  Alternatives, such as Option 1 and Option 8 above, are generally preferred and
offer a better solution for most customers.
to:

'''IMPORTANT: This API is now deprecated and no longer supported for new developments''' This information is provided for historical users.

Alternatives, such as Option 1 and Option 8 above  offer
a better solution for most customers.

The ''External Account Source'' API allows 3rd party system integrators to develop interfaces to instruct
PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).
September 28, 2015, at 03:25 AM by Alec - Remove access to Vending API docs.
Changed lines 54-56 from:
Documentation for this API is distributed with PaperCut MF, and can be found at @@[app-path]/release/examples/extensions/credit-sources/@@, including a readme file, API documentation and some mock implementations.  These should provide enough information for a developer to start implementing the integration.

For further details contact support
.  Customers using devices that integrate via this API will need to be running PaperCut MF and purchase a ''Pay Station'' license for each device.  All implementations also need to be certified by PaperCut.
to:

Please contact support to discuss the API access
, development licenses, and functional requirements.  Customers using devices that integrate via this API will need to be running PaperCut MF and purchase a ''Pay Station'' license for each device.  All implementations also need to be certified by PaperCut.
June 18, 2015, at 04:25 AM by Alec - Remove public access to SSO and Release Station APIs
Added line 65:
Changed lines 73-75 from:
->[[Attach:PaperCut Device REST Web Service API.pdf | PaperCut Device REST Web Service API]] (PDF)

to:
(:comment ->[[Attach:PaperCut Device REST Web Service API.pdf | PaperCut Device REST Web Service API]] (PDF) :)

Please contact support to discuss the API access, development licenses, and functional requirements.  Vendors should offer quality assurance commitments (to ensure compatibility is maintained over time). 


Changed lines 101-103 from:
->[[Attach: ReleaseStation API- XMLRPC - V2.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF)
to:
(:comment ->[[Attach: ReleaseStation API- XMLRPC - V2.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF) :)

Please contact support to discuss the API access, development licenses, and functional requirements.  Vendors should offer quality assurance commitments (to ensure compatibility is maintained over time). 
July 17, 2014, at 04:52 AM by geoff - De-emphasise EAS, add top-up on demand payment gateway
Added lines 25-31:
!!!Account Recharge System (Manual Payment Gateway)
An in-house system for re-charging a user's PaperCut account can be implemented using the public `API as follows:

* A [[https://www.papercut.com/products/ng/manual/ch-customization-user-web-pages.html#ch-customization-user-web-pages-nav-links | Custom Link]] in the user web page is used to link to your in-house payment recharge page.
* The user enters the amount to recharge and your system calls [@api.adjustUserAccountBalance@] to adjust the PaperCut balance.
* The user is returned to the user web page and sees the new balance displayed.

Added line 67:
Changed lines 75-89 from:
!!Option 8 - Outbound External Account API (Advanced)
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  This feature/setting is also known as an ''External Account Source''.  These documents cover the ''Outbound `API'' set and should be read in conjunction with the standard ''Inbound Web Services `APIs'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the
[[mailto:support@papercut.com | PaperCut development team]].'''  End-users must pay a small license fee to enable support for leveraging an external account source.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)

->[[Attach:ExternalAccountSynchronization-FeaturesAndSupportedWorkflows.pdf |External Account Synchronization - Features and Supported Workflows ]] (PDF
)

->[[Attach:External Account XMLRPC Interface - Basic User Details.pdf | External Account XML-RPC Interface - Simplified interface for Basic User Details]] (PDF)

->[[Attach:External Account XMLRPC Interface - Full Interface.pdf | External Account XML-RPC Interface - Full Interface]] (PDF)

Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer
any questions and/or work with system integrators to find the best solutionsImplementers should take considerable care in development and integration as implementations effectively replace PaperCut's database so any failures will extend through all layers of the system.


!!Option 9
- Intranet integration via gadgets/widgets and AJAX
to:
!!Option 8 - Custom Top-up on Demand Payment Gateway (Advanced)
A top-up on demand payment gateway credits a user's balance in real-time with the amount needed to fulfill a print job.   PaperCut offers top-up on demand payment gateway integrations with several popular third party payment systems (see [[https://www.papercut.com/tour/balance-recharge/online-payment-gateways/|Payment Gateway Tour page]].) 

PaperCut also provides an API for system integrators to develop a custom in-house top-up on demand payment gateway.  This API can be used to address most situations where customers wish to use an external system to automatically provide credit for printing
.  

Please contact the
[[mailto:support@papercut.com | PaperCut development team]] for more information.


!!Option 9
- Outbound External Account API (Advanced)
The ''External Account Source'' API allows 3rd party system integrators to develop interfaces to instruct PaperCut
to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time)

The External Account Source API is a complex topic!  The PaperCut Software Development Team is happy to provide documentation and work with system integrators to find the best solutions.
  Implementers should take considerable care in development and integration as implementations effectively replace PaperCut's account database so any failures will extend through all layers of the system(A buggy implementation will take down PaperCut!)

'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  Alternatives, such as Option 1 and Option 8 above, are generally preferred and
offer a better solution for most customers.

!!Option 10
- Intranet integration via gadgets/widgets and AJAX
Changed line 96 from:
!!Option 10 - Hold/Release Queue and Release Station API
to:
!!Option 11 - Hold/Release Queue and Release Station API
June 20, 2014, at 04:32 PM by TimG - Updated from pubic to public... lol.
Changed lines 23-24 from:
All pubic `APIs are open, documented and free to use by either PaperCut administrators, system integrators or middleware developers.
to:
All public `APIs are open, documented and free to use by either PaperCut administrators, system integrators or middleware developers.
Changed lines 88-90 from:
->[[Attach: ReleaseStation API- XMLRPC -V2.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF)

to:
->[[Attach: ReleaseStation API- XMLRPC - V2.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF)

Changed lines 88-90 from:
->[[Attach: ReleaseStation API- XMLRPC.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF)

to:
->[[Attach: ReleaseStation API- XMLRPC -V2.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF)

Changed lines 92-93 from:
Several of the `APIs above make reference to the [[ProductCertification|certification process]]. This is explained [[ProductCertification | here]]. Details are also available regarding [[https://www.papercut.com/kb/Main/CertifiedIntegrationTechnology|PaperCut's Certified Integration Technology]] label, awarded to certified solutions that integrate with PaperCut.
to:
Several of the `APIs above make reference to the [[ProductCertification|certification process]]. This is explained [[ProductCertification | here]]. Details are also available regarding [[https://www.papercut.com/kb/Main/CertifiedIntegrationTechnology|PaperCut's Certified Integration Technology]] program, for certifying solutions that integrate with PaperCut.
March 14, 2013, at 07:29 AM by ian - crosslink to new Certified Integration Technology KB
Changed lines 92-93 from:
Several of the `APIs above make reference to the [[ProductCertification|certification process]]. This is explained [[ProductCertification | here]]
to:
Several of the `APIs above make reference to the [[ProductCertification|certification process]]. This is explained [[ProductCertification | here]]. Details are also available regarding [[https://www.papercut.com/kb/Main/CertifiedIntegrationTechnology|PaperCut's Certified Integration Technology]] label, awarded to certified solutions that integrate with PaperCut.
February 22, 2013, at 12:33 AM by matt - Add Device REST API
Changed lines 60-61 from:

!!Option 7 - Outbound External Account API (Advanced)
to:
!!Option 7 - Device REST API (for Device SSO)

This API allows 3rd party applications to query PaperCut for the list of connected external devices (e.g. MFPs running embedded software, hardware terminals, etc).  This API allows the callers to determine the user logged into the device.  This can be used for Single Sign-on for other 3rd party applications (e.g. embedded scan applications).

->[[Attach:PaperCut Device REST Web Service API.pdf | PaperCut Device REST Web Service API]] (PDF)


!!Option 8
- Outbound External Account API (Advanced)
Changed line 81 from:
!!Option 8 - Intranet integration via gadgets/widgets and AJAX
to:
!!Option 9 - Intranet integration via gadgets/widgets and AJAX
Changed line 86 from:
!!Option 9 - Hold/Release Queue and Release Station API
to:
!!Option 10 - Hold/Release Queue and Release Station API
Changed lines 26-27 from:
A popular option for extending PaperCut's behavior to implement tasks such as print routing, redirection, print policies, etc. is to use the [[https://www.papercut.com/products/ng/manual/ch-script.html|Print Scripting Feature]]. Print Scripting offers a rich range of `APIs and these can be used to implement many print workflow automation tasks.
to:
A popular option for extending PaperCut's behaviour to implement tasks such as print routing, redirection, print policies, etc. is to use the [[https://www.papercut.com/products/ng/manual/ch-script.html|Print Scripting Feature]]. Print Scripting offers a rich range of `APIs and these can be used to implement many print workflow automation tasks.
Changed line 32 from:
There is an advanced internal web services API specially designed for smart cash loading devices such as vending hardware and kiosk stations.  This API is only avaliable for PaperCut MF.  It offers:
to:
There is an advanced internal web services API specially designed for smart cash loading devices such as vending hardware and kiosk stations.  This API is only available for PaperCut MF.  It offers:
Changed line 53 from:
There is an advanced internal web services API specially designed for smart hardware copier terminal devices (copier controls) that can track and/or restrict copying, allowing copies to be reported to PaperCut for tracking and charging.  This API is only avaliable for PaperCut MF.  It offers:
to:
There is an advanced internal web services API specially designed for smart hardware copier terminal devices (copier controls) that can track and/or restrict copying, allowing copies to be reported to PaperCut for tracking and charging.  This API is only available for PaperCut MF.  It offers:
Changed lines 86-87 from:
Several of the `APIs above make reference to the [[ProductCertificationPaperCut|certification process]]. This is explained [[ProductCertification | here]]
to:
Several of the `APIs above make reference to the [[ProductCertification|certification process]]. This is explained [[ProductCertification | here]]
Changed lines 86-87 from:
Several of the `APIs above make reference to the PaperCut certification process. This is explained [[ProductCertification | here]]
to:
Several of the `APIs above make reference to the [[ProductCertificationPaperCut|certification process]]. This is explained [[ProductCertification | here]]
Changed line 95 from:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
to:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
Added lines 66-67:
->[[Attach:ExternalAccountSynchronization-FeaturesAndSupportedWorkflows.pdf |External Account Synchronization - Features and Supported Workflows ]] (PDF)
Changed line 82 from:
\\
to:
Changed line 83 from:
to:
!!Certification
October 16, 2012, at 05:20 AM by Alec - Added reference to Certification page
Added lines 84-85:
Several of the `APIs above make reference to the PaperCut certification process. This is explained [[ProductCertification | here]]
October 01, 2012, at 03:12 AM by Alec - Fixed typo
Changed line 52 from:
!!Option 6 - Copier Terminal/Controller and API
to:
!!Option 6 - Copier Terminal and Controller API
Changed lines 64-73 from:
'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  End-users must pay a small license fee to enable support for leveraging and external account source.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)

->[[Attach:External Account XMLRPC Interface - Basic User Details.pdf | External Account XMLRPC Interface - Simplified interface for Basic User Details]] (PDF)

->[[Attach:External Account XMLRPC Interface - Full Interface.pdf | External Account XMLRPC Interface - Full Interface]] (PDF)

->[[Attach: ReleaseStation API- XMLRPC.pdf | Hold/Release Queue and Release Station API - XMLRPC]] (PDF)

Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.  Implementers should take considerable care in development any integration as any source effectively replaces PaperCut's database so any failures will extend through all layers of the
system.
to:
'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  End-users must pay a small license fee to enable support for leveraging an external account source.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)

->[[Attach:External Account XMLRPC Interface - Basic User Details.pdf | External Account XML-RPC Interface - Simplified interface for Basic User Details]] (PDF)

->[[Attach:External Account XMLRPC Interface - Full Interface.pdf | External Account XML-RPC Interface - Full Interface]] (PDF)

Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.  Implementers should take considerable care in development and integration as implementations effectively replace PaperCut's database so any failures will extend through all layers of the system.

Added lines 78-81:
!!Option 9 - Hold/Release Queue and Release Station API
A rarely used API, this can be used to list, release and cancel/delete print jobs from hold/release queues, in addition to basic user authentication.
->[[Attach: ReleaseStation API- XMLRPC.pdf | Hold/Release Queue and Release Station API - XML-RPC]] (PDF)

Changed line 91 from:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
to:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
July 27, 2012, at 12:17 AM by 203.222.91.204 -
Changed lines 29-30 from:
Organizations wishing to replace PaperCut's LDAP/AD/eDiretory/`OpenDirectory user direction support with a custom user directory provide may do so using the ''Custom User Information Directory Provider'' API.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in [[https://www.papercut.com/products/ng/manual/ch-customization-user-provider.html|Chapter 16]] in the PaperCut manual.
to:
Organizations wishing to replace PaperCut's LDAP/AD/eDiretory/`OpenDirectory user direction support with a custom user directory provide may do so using a ''Custom User Information Directory Provider''.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in [[https://www.papercut.com/products/ng/manual/ch-customization-user-provider.html|Chapter 16]] in the PaperCut manual.
Changed lines 25-28 from:
!!Option 2 - User Directory Integration `APIs (Advanced)
to:
!!Option 2 - Print Scripting API
A popular option for extending PaperCut's behavior to implement tasks such as print routing, redirection, print policies, etc. is to use the [[https://www.papercut.com/products/ng/manual/ch-script.html|Print Scripting Feature]]. Print Scripting offers a rich range of `APIs and these can be used to implement many print workflow automation tasks.

!!Option 3
- User Directory Integration `APIs (Advanced)
Changed line 31 from:
!!Option 3 - Standalone Cash Loader and Kiosk API (Advanced)
to:
!!Option 4 - Standalone Cash Loader and Kiosk API (Advanced)
Changed line 40 from:
!!Option 4 - Vending API in the Release Station and/or Pay Station (Advanced)
to:
!!Option 5 - Vending API in the Release Station and/or Pay Station (Advanced)
Changed line 52 from:
!!Option 5 - Copier Terminal/Controller and API
to:
!!Option 6 - Copier Terminal/Controller and API
Changed line 61 from:
!!Option 6 - Outbound External Account API (Advanced)
to:
!!Option 7 - Outbound External Account API (Advanced)
Changed line 74 from:
!!Option 7 - Intranet integration via gadgets/widgets and AJAX
to:
!!Option 8 - Intranet integration via gadgets/widgets and AJAX
Changed line 88 from:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
to:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
Changed lines 42-43 from:
An overview of the pay/release station software (including screenshots) is provided in the PaperCut MF tour section [[http://www.papercut-mf.com/tour/balance-recharge/cash-payment-hardware/|Cash Payment Hardware]].
to:
An overview of the pay/release station software (including screenshots) is provided in the PaperCut MF tour section [[http://www.papercut-mf.com/tour/cash-payment-hardware/|Cash Payment Hardware]].
Changed lines 55-57 from:
Please contact support to discuss the API access, development licenses, and functional requirements.  Each site using the implementation must pay a small license fee applies to enable the APIs (a Copier Controller Terminal License).  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments (to ensure compatibility is maintained over time). 

to:
Please contact support to discuss the API access, development licenses, and functional requirements.  Each site using the implementation must pay a small license fee applies to enable the `APIs (a Copier Controller Terminal License).  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments (to ensure compatibility is maintained over time). 

Changed line 72 from:
A simple set of AJAX widgets and JSON based reset `APIs are avaliable to assist with basic Intranet integration.  See:
to:
A simple set of AJAX widgets and JSON based REST `APIs are avaliable to assist with basic Intranet integration.  See:
Added lines 23-24:
All pubic `APIs are open, documented and free to use by either PaperCut administrators, system integrators or middleware developers.
Changed lines 53-55 from:
Please contact support for details.  Customers must pay a small license fee applies to enable this support.  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments. 

to:
Please contact support to discuss the API access, development licenses, and functional requirements.  Each site using the implementation must pay a small license fee applies to enable the APIs (a Copier Controller Terminal License).  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments (to ensure compatibility is maintained over time)

Changed lines 13-14 from:
APIs are primarily focused around a Web Services approach using XML-RPC as the preferred format.  Recently some APIs have been also been exposed in a REST form (JSON and XML).  Example code and wrapper classes are provided for many leading programming languages.
to:
`APIs are primarily presented as Web Services approach using XML-RPC as the preferred format.  Recently some `APIs have been also been exposed in a REST form (JSON and XML).  Example code and wrapper classes are provided for many leading programming languages.
April 08, 2011, at 01:48 AM by 202.129.124.120 -
Added lines 13-14:
APIs are primarily focused around a Web Services approach using XML-RPC as the preferred format.  Recently some APIs have been also been exposed in a REST form (JSON and XML).  Example code and wrapper classes are provided for many leading programming languages.
April 08, 2011, at 01:45 AM by 202.129.124.120 -
Changed lines 51-53 from:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments. 

to:
Please contact support for details.  Customers must pay a small license fee applies to enable this support.  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments. 

Changed lines 55-58 from:
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).   These documents cover the ''Outbound `API'' set and should be read in conjunction with the standard ''Inbound Web Services `APIs'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  A small license fee applies for using this API.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)
to:
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  This feature/setting is also known as an ''External Account Source''.  These documents cover the ''Outbound `API'' set and should be read in conjunction with the standard ''Inbound Web Services `APIs'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  End-users must pay a small license fee to enable support for leveraging and external account source.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)
Changed lines 65-66 from:
Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.
to:
Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.  Implementers should take considerable care in development any integration as any source effectively replaces PaperCut's database so any failures will extend through all layers of the system.
April 07, 2011, at 11:04 PM by 202.129.124.120 -
Changed line 81 from:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware-]
to:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware, external account source-]
Changed lines 69-71 from:
-->[[https://www.papercut.com/products/ng/manual/ch-user-services-gadgets.html|PaperCut Gadgets/Widgets]]

to:
->[[https://www.papercut.com/products/ng/manual/ch-user-services-gadgets.html|PaperCut Gadgets/Widgets]]

Changed line 68 from:
A simple set of AJAX widgets and JSON based reset APIs are avaliable to assist with basic Intranet integration.  See:
to:
A simple set of AJAX widgets and JSON based reset `APIs are avaliable to assist with basic Intranet integration.  See:
Added lines 67-71:
!!Option 7 - Intranet integration via gadgets/widgets and AJAX
A simple set of AJAX widgets and JSON based reset APIs are avaliable to assist with basic Intranet integration.  See:
-->[[https://www.papercut.com/products/ng/manual/ch-user-services-gadgets.html|PaperCut Gadgets/Widgets]]

Changed lines 76-77 from:
to:
* [[MoodleBlocks|+]]
Changed lines 45-46 from:
!!Option 5 - Copier Terminal and API
There is an advanced internal web services API specially designed for smart copier terminal devices that can track and/or restrict copying, allowing copies to be reported to PaperCut for tracking and charging.  This API is only avaliable for PaperCut MF.  It offers:
to:
!!Option 5 - Copier Terminal/Controller and API
There is an advanced internal web services API specially designed for smart hardware copier terminal devices (copier controls) that can track and/or restrict copying, allowing copies to be reported to PaperCut for tracking and charging.  This API is only avaliable for PaperCut MF.  It offers:
Changed lines 51-53 from:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] and be certified by PaperCut and vendors are required to offer quality assurance commitments. 

to:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] to be certified by PaperCut and vendors are required to offer quality assurance commitments. 

Changed lines 51-53 from:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to be certified by PaperCut and vendors are required to offer quality assurance commitments.

to:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to complete a set of [[ExternalDeviceTestCases | test cases]] and be certified by PaperCut and vendors are required to offer quality assurance commitments.  

Changed lines 63-64 from:
->[[Attach: ReleaseStation API- XMLRPC.pdf | Release Station API - XMLRPC]] (PDF)
to:
->[[Attach: ReleaseStation API- XMLRPC.pdf | Hold/Release Queue and Release Station API - XMLRPC]] (PDF)
Added lines 67-71:
\\

!!See also
* [[https://www.papercut.com/products/ng/manual/ch-user-mgmt-card-db-lookup.html|Looking up card numbers in an external database]]

Changed lines 21-23 from:
!!Option 2 - User Directory Intergration APIs
Organizations
wishing to replace PaperCut's LDAP/AD/eDiretory/OpenDirectory user direction support with a custom user directory provide may do so using the ''Custom User Information Directory Provider'' API.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in [[https://www.papercut.com/products/ng/manual/ch-customization-user-provider.html|Chapter 16]] in the PaperCut manual.
to:
!!Option 2 - User Directory Integration `APIs (Advanced)
Organizations
wishing to replace PaperCut's LDAP/AD/eDiretory/`OpenDirectory user direction support with a custom user directory provide may do so using the ''Custom User Information Directory Provider'' API.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in [[https://www.papercut.com/products/ng/manual/ch-customization-user-provider.html|Chapter 16]] in the PaperCut manual.
Changed lines 5-6 from:
The following API documentation is provided to support system integrators wishing to undertake development to hook PaperCut in with other systems.  Reasons for considering integration include:
to:
The following API documentation is provided to support '''system integrators''' wishing to undertake development to hook PaperCut in with other systems.  Reasons for considering integration include:
Changed lines 21-22 from:

!!Option 2 - Standalone Cash Loader and Kiosk API (Advanced)
to:
!!Option 2 - User Directory Intergration APIs
Organizations wishing to replace PaperCut's LDAP/AD/eDiretory/OpenDirectory user direction support with a custom user directory provide may do so using the ''Custom User Information Directory Provider'' API.  This takes the form of an external command-line process designed to output data in a prescribed format.  More information, including references to example code can be found in [[https://www.papercut.com/products/ng/manual/ch-customization-user-provider.html|Chapter 16]] in the PaperCut manual.

!!Option 3
- Standalone Cash Loader and Kiosk API (Advanced)
Changed line 33 from:
!!Option 3 - Vending API in the Release Station and/or Pay Station (Advanced)
to:
!!Option 4 - Vending API in the Release Station and/or Pay Station (Advanced)
Changed line 45 from:
!!Option 4 - Copier Terminal and API
to:
!!Option 5 - Copier Terminal and API
Changed lines 51-54 from:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to be certified by PaperCut.


!!Option 5
- Outbound External Account API (Advanced)
to:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to be certified by PaperCut and vendors are required to offer quality assurance commitments.


!!Option 6
- Outbound External Account API (Advanced)
Changed lines 17-18 from:
These XML web services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the [@api.adjustUserAccountBalance@] call for more details.  Example source code in C#, Java, Python, PHP and Ruby is provided.
to:
These XML web services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the [@api.adjustUserAccountBalance@] call for more details.  Helper utilities and example source code in C#, Java, Python, PHP and Ruby is provided.
Added lines 36-37:
An overview of the pay/release station software (including screenshots) is provided in the PaperCut MF tour section [[http://www.papercut-mf.com/tour/balance-recharge/cash-payment-hardware/|Cash Payment Hardware]].
Changed lines 22-36 from:
!!Option 2 - Outbound External Account API (Advanced)
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound `API'' set and should be read in conjunction with the standard ''Inbound Web Services `APIs'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the [[ mailto:support@papercut.com | PaperCut development team ]].'''  A small license fee applies for using this API.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)

->[[Attach:External Account XMLRPC Interface - Basic User Details.pdf | External Account XMLRPC Interface - Simplified interface for Basic User Details]] (PDF)

->[[Attach:External Account XMLRPC Interface - Full Interface.pdf | External Account XMLRPC Interface - Full Interface]] (PDF)

->[[Attach: ReleaseStation API- XMLRPC.pdf | Release Station API - XMLRPC]] (PDF)

Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.


!!Option 3
- Standalone Cash Loader and Kiosk API (Advanced)
to:
!!Option 2 - Standalone Cash Loader and Kiosk API (Advanced)
Changed line 24 from:
* The ability for the device to self register itself in PaperCut's database.
to:
* The ability for the device to register itself with PaperCut.
Changed line 31 from:
!!Option 4 - Vending API in the Release Station and/or Pay Station (Advanced)
to:
!!Option 3 - Vending API in the Release Station and/or Pay Station (Advanced)
Added lines 35-46:

Documentation for this API is distributed with PaperCut MF, and can be found at @@[app-path]/release/examples/extensions/credit-sources/@@, including a readme file, API documentation and some mock implementations.  These should provide enough information for a developer to start implementing the integration.

For further details contact support.  Customers using devices that integrate via this API will need to be running PaperCut MF and purchase a ''Pay Station'' license for each device.  All implementations also need to be certified by PaperCut.


!!Option 4 - Copier Terminal and API
There is an advanced internal web services API specially designed for smart copier terminal devices that can track and/or restrict copying, allowing copies to be reported to PaperCut for tracking and charging.  This API is only avaliable for PaperCut MF.  It offers:
* The ability for the device to register itself with PaperCut.
* The device appears as a "device" in PaperCut offering configuration from the web interface.
* The status of the device can be monitored from PaperCut.
* There is a separate dedicated job log showing jobs tracked by the device.
Added lines 49-62:

!!Option 5 - Outbound External Account API (Advanced)
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound `API'' set and should be read in conjunction with the standard ''Inbound Web Services `APIs'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the [[mailto:support@papercut.com | PaperCut development team]].'''  A small license fee applies for using this API.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)

->[[Attach:External Account XMLRPC Interface - Basic User Details.pdf | External Account XMLRPC Interface - Simplified interface for Basic User Details]] (PDF)

->[[Attach:External Account XMLRPC Interface - Full Interface.pdf | External Account XMLRPC Interface - Full Interface]] (PDF)

->[[Attach: ReleaseStation API- XMLRPC.pdf | Release Station API - XMLRPC]] (PDF)

Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.

Changed line 2 from:
(:description :)
to:
(:description Integrating external systems and devices with PaperCut using programming and scripting APIs.:)
Changed lines 19-21 from:
The web services APIs are also available as a command line scripting tool, [[https://www.papercut.com/products/ng/manual/apdx-tools.html#apdx-tools-server-command | server-command]].

to:
The web services `APIs are also available via a command line scripting tool, [[https://www.papercut.com/products/ng/manual/apdx-tools.html#apdx-tools-server-command | server-command]].  This method is ideal for usage from batch files, shell scripts and cron jobs.

Changed lines 33-35 from:
Outbound 'APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.

to:
Outbound `APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.

Changed lines 1-2 from:
(:title External System and Integration APIs :)
to:
(:title External System and Integration APIs:)
(:description :)
(:keywords PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware
:)
Changed lines 15-16 from:
''Important: Always review the list of [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | standard public APIs]] for your first development option rather than these advanced options below.''
to:
Changed lines 17-19 from:
Use the public `APIs.  These XML Web Services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the [@api.adjustUserAccountBalance@] call for more details.  Example source code in C#, Java, Python, PHP and Ruby is provided.

to:
These XML web services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the [@api.adjustUserAccountBalance@] call for more details.  Example source code in C#, Java, Python, PHP and Ruby is provided.

The web services APIs are also available as a command line scripting tool, [[https://www.papercut.com/products/ng/manual/apdx-tools.html#apdx-tools-server-command | server-command]]
.

Changed lines 23-24 from:
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
to:
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound `API'' set and should be read in conjunction with the standard ''Inbound Web Services `APIs'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
Changed lines 33-37 from:
Outbound [=APIs=] are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.


!!Option 3 - Cash Loader and Kiosk API (Advanced)
There is an advanced internal Web Services API specially designed for smart cash loadind devices such as vending Kiosks and Kiosk stations. This API is only avaliable for PaperCut MF. It offers:
to:
Outbound 'APIs are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.


!!Option 3 - Standalone Cash Loader and Kiosk API (Advanced)
There is an advanced internal web services API specially designed for smart cash loading devices such as vending hardware and kiosk stations.  This API is only avaliable for PaperCut MF.  It offers:
Changed lines 39-40 from:
* The device appears as a "device" in PaperCut offering configuration from the web interface
* The status of the device can be monitored from PaperCut
to:
* The device appears as a "device" in PaperCut offering configuration from the web interface.
* The status of the device can be monitored from PaperCut.
Changed lines 45-46 from:
!!Option 3 - Cash Vending API in the Release Station and/or Pay Station (Advanced)
This API is targeted at simple cash handling device support USB or Serial or stored value card equipment.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
to:
!!Option 4 - Vending API in the Release Station and/or Pay Station (Advanced)
This API is targeted at simple cash or stored value card equipment that can connect to a computer via a USB or serial cable.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
Deleted line 50:
Changed lines 52-53 from:
[-keywords: api, xml-rpc, soap, api, dll, middleware -]
to:
''Categories:'' [[Category.API|+]]
Changed line 54 from:
''Categories:'' [[!API]]
to:
[-Keywords: PaperCut integration, vending API, XML-RPC, SOAP, DLL, middleware-]
Changed line 19 from:
!!Option 2 - Outbound External Account XML-RPC Web Service API (Advanced)
to:
!!Option 2 - Outbound External Account API (Advanced)
Changed line 36 from:
* The device appears as a "device" in PaperCut oofering configuration from the web interface
to:
* The device appears as a "device" in PaperCut offering configuration from the web interface
Deleted lines 48-50:


Added lines 50-52:
[-keywords: api, xml-rpc, soap, api, dll, middleware -]

----
Deleted line 10:
Deleted line 12:
Changed line 15 from:
!!Option 1 - Public `APIs (Inbound APIs)
to:
!!Option 1 - Public `APIs (Inbound `APIs)
Changed lines 17-22 from:
!!Option 1 - Public `APIs
Use the public APIs.  These XML Web Services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound `API documentation]] and the
->[@api.adjustUserAccountBalance@]
call for more details.  Example source code in C#, Java, Python, PHP and Ruby is provided.

to:
!!Option 1 - Public `APIs (Inbound APIs)
Use the public `APIs.  These XML Web Services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the
[[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the [@api.adjustUserAccountBalance@] call for more details.  Example source code in C#, Java, Python, PHP and Ruby is provided.

Changed lines 22-23 from:
This `API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
to:
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
Changed line 45 from:
This `API is targeted at simple cash handling device support USB or Serial or stored value card equipment.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
to:
This API is targeted at simple cash handling device support USB or Serial or stored value card equipment.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
Changed lines 17-18 from:
!!Option 1 - Public APIs
Use the public APIs.  These XML Web Services APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the
to:
!!Option 1 - Public `APIs
Use the public APIs.  These XML Web Services `APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the `APIs can be used to "push" funds (i.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound `API documentation]] and the
Changed lines 24-25 from:
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
to:
This `API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
Changed line 47 from:
This API is targeted at simple cash handeling device support USB or Serial or stored value card equipment.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
to:
This `API is targeted at simple cash handling device support USB or Serial or stored value card equipment.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
Deleted lines 49-54:

This API offers:
* Interaction with the release station and/or
* The device then appears as a "device" in PaperCut
* The status of the device can be monitored from PaperCut
* There is a separate dedicated transaction log and associated reconciliation reports.
Added line 55:
Changed lines 12-14 from:
These integration options are possible using one of three options:

to:
These integration options are possible using one of the following options:

Changed lines 17-21 from:
!!Option 1 - Outbound External Account XML-RPC Web Service API
The API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time)
.   These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the [[ mailto:support@papercut.com | PaperCut development team ]]
.'''  A small license fee applies for using this API to cover our extra support overhead.
to:
!!Option 1 - Public APIs
Use the public APIs.  These XML Web Services APIs are included as standard with PaperCut and have no additional costs or certification requirements.  They are open, supported and fully documented.  For example the APIs can be used to "push" funds (i
.e. transfer) from an external source into a PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the
->[@api.adjustUserAccountBalance@]
call for more details.  Example source code in C#, Java, Python, PHP and Ruby is provided
.


!!Option 2 - Outbound External Account XML-RPC Web Service
API (Advanced)
This API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i
.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].

'''IMPORTANT: Before starting you should discuss your options with the [[ mailto:support@papercut.com | PaperCut development team ]].'''  A small license fee applies for using this API.  All implementations also need to be certified (because if your implementation is buggy, you'll take down PaperCut!)

Changed lines 37-49 from:

!!Option 2 - Inbound XML-RPC Web Service API
An alternate and simpler option to the ''External Account XML-RPC'' interface is to use the in-bound API and allow users to "push" funds (i.e. transfer) into their PaperCut account.  See the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | Inbound API documentation]] and the
->[@api.adjustUserAccountBalance@]
call for more details
.

!!Option 3 - Payment Gateway
A third option may be to have your service added as an official credit source in the PaperCut [[https://www.papercut.com/support/payment_gateway/ | Payment Gateway]], allowing end-users to "pull" funds out of the external source direct from their PaperCut login account screen.  Please contact support for details.

!!Option 3 - Cash Loader API
There is an advanced internal Web Services API specially designed for cash loads.  It offers:
* The ability for the device to self register.
* The device then appears as a "device" in PaperCut
to:
!!Option 3 - Cash Loader and Kiosk API (Advanced)
There is an advanced internal Web Services API specially designed for smart cash loadind devices such as vending Kiosks and Kiosk stations. This API is only avaliable for PaperCut MF. It offers
:
* The ability for the device to self register itself in PaperCut's database.
* The device appears as a "device" in PaperCut oofering configuration from the web interface
Changed lines 43-45 from:
Please contact support for details.

to:
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to be certified by PaperCut.


!!Option 3 - Cash Vending API in the Release Station and/or Pay Station (Advanced)
This API is targeted at simple cash handeling device support USB or Serial or stored value card equipment.  It allows vendors to connect their devices as ''funds sources'' into the PaperCut for:
*'''Pay and Release''': Users can pay cash and release jobs at a release station.
*'''Pay Station''': Users can put funds into PaperCut using the release station software running in ''Pay Station'' mode.

This API offers:
* Interaction with the release station and/or
* The device then appears as a "device" in PaperCut
* The status of the device can be monitored from PaperCut
* There is a separate dedicated transaction log and associated reconciliation reports.
Please contact support for details.  A small license fee applies to enable this API.  All implementations also need to be certified by PaperCut.



Changed lines 20-21 from:
'''IMPORTANT: Before starting you should discuss your options with the [[ mailto:support@papercut.com | PaperCut development team ]].'''
to:
'''IMPORTANT: Before starting you should discuss your options with the [[ mailto:support@papercut.com | PaperCut development team ]].'''  A small license fee applies for using this API to cover our extra support overhead.
May 05, 2009, at 06:25 PM by 71.117.221.94 -
Changed lines 3-4 from:
The following API documentation is provided to support system integrators undertake development to hook PaperCut in with other systems.  Reasons for considering integration include:
to:
The following API documentation is provided to support system integrators wishing to undertake development to hook PaperCut in with other systems.  Reasons for considering integration include:
Changed lines 18-19 from:
The API set allow 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
to:
The API set allows 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
Changed lines 28-31 from:
Outbound [=APIs=] are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrates to find the best solutions.


to:
Outbound [=APIs=] are a complex topic!  The PaperCut Software Development Team is happy to answer any questions and/or work with system integrators to find the best solutions.


Changed lines 18-19 from:
The API set allow 3rd party system integrates to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
to:
The API set allow 3rd party system integrators to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time).  These documents cover the ''Outbound [=API=]'' set and should be read in conjunction with the standard ''Inbound Web Services [=APIs=]'' discussed in detail in the [[https://www.papercut.com/products/ng/manual/apdx-tools-web-services.html | PaperCut Public API documentation]].
Changed lines 38-39 from:
A third option may be to have your service added as an official credit source in the PaperCut [[https://www.papercut.com/support/payment_gateway/ | Payment Gateway]], allowing end-users to "pull" funds out of the external source direct from their PaperCut login account screen.
to:
A third option may be to have your service added as an official credit source in the PaperCut [[https://www.papercut.com/support/payment_gateway/ | Payment Gateway]], allowing end-users to "pull" funds out of the external source direct from their PaperCut login account screen.  Please contact support for details.
Changed lines 46-47 from:

to:
Please contact support for details.

Changed lines 40-47 from:
to:
!!Option 3 - Cash Loader API
There is an advanced internal Web Services API specially designed for cash loads.  It offers:
* The ability for the device to self register.
* The device then appears as a "device" in PaperCut
* The status of the device can be monitored from PaperCut
* There is a separate dedicated transaction log and associated reconciliation reports.

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.

Article last modified on November 21, 2018, at 11:45 PM
Printable View   |   Article History   |   Edit Article