A Python library for interfacing with Procuret API. Procuret is a business - to - business payment platform that allows customers to pay for purchases over time, while the supplier is paid upfront.
Procuret Python may be installed via PIP:
$ pip install procuret
To update Procuret Python to the latest version, use pip --upgrade:
$ pip install --upgrade procuret
Procuret Python offers a library of classes that map to services provided by the Procuret API.
SessionSessions are the means of authenticating requests to the Procuret API. All requests to Procuret API, save for those creating Sessions themselves, require a Session.
In Procuret Python, the Session class will handle all authentication for you.
For example, it will compute the SHA256 signature that must be included
in your HTTP headers.
.session_id: int - A 63-bit positive integer uniquely identifying this
Session. Session will include this number in requests to Procuret API, so
that Procuret API can identify you..api_key - A 192-bit random number encoded in urlsafe base64 and generated
in a cryptographically secure manner. Session will use this key to sign your
requests to Procuret API using the SHA256 algorithm..create_with_email(...) -> SessionUse .create_with_email() to create a new Session. This is analogous to
"logging in" to the Procuret API.
email: str - Your account emailplaintext_secret: str - Your plaintext passphraseperspective: Perspective - an instance of Perspectivecode: str - A two factor authentication code. Obtain via SecondFactorCodelifecycle: Lifecycle - Defaults to .LONG_LIVEDsession = Session.create_with_email(
email='me@somedomain.com',
plaintext_secret='excellent passphrase',
perspective=Perspective.SUPPLIER,
code='123456'
)
.from_interactive_prompt() -> SessionCall this method to use an interactive Session creation procedure.
SecondFactorCodeSecondFactorCode allows you to generate two-factor authentication codes for
use in creating Session instances.
.create_with_email(...) -> NoneThis method will cause a two-factor authorisation code to be sent to the
communication method associated with your Procuret account. You can then
use that code as the code parameter when creating a Session.
email: str - Your account emailplaintext_secret: str - Your plaintext passphraseperspective: Perspective - an instance of PerspectiveSecondFactorCode.create_with_email(
email='someone@somewhere.com',
plaintext_secret='excellent passphrase',
perspective=Perspective.BUSINESS
)
InstalmentLinkInstalmentLink facilitates the creation of customised links to the Procuret
Instalment Product (PIP). PIP allows a customer Business to pay for a purchase
over time, while you the Supplier are paid upfront.
When you create an InstalmentLink, you can ask Procuret to send an email
to the customer Business on your behalf.
.invitee_email: str - The email address you associated with the link.invoice_amount: Decimal - The invoice amount presented by the link.invoice_identifier: str - The invoice ID presented by the link.url: str - The URL of the link.create(...) -> InstalmentLinksupplier: Union[int, EntityHeadline] - Either the unique integer
identifier of your Supplier entity in Procuret, or an instead of
EntityHeadline describing your Supplier entity.invoice_amount: Decimal - The amount that you wish to charge the customer,
in Australian dollars.invoice_email: str - The email address you wish to associate with this
link.invoice_identifier: str - Your own identifier for the invoice. For
example, you might use an invoice number from your accounting system.communication: CommunicationOption - An instance of CommunicationOption,
which will tell Procuret API what you want it to do with the supplied email
address.session: Session - An instance of Session, which will be used to
authenticate your request.# First we get a Session. In this case we authenticate with email and
# passphrase. In a real integration, you might store the Session elsehwhere.
session = Session.create_with_email(
email=email,
plaintext_secret=secret,
perspective=Perspective.SUPPLIER,
code='12346' # Obtained via `SecondFactorCode`
)
# Now we use the Session in an InstalmentLink.create() call, along with
# the parameters describing the link. By supplying
# CommunicationOption.EMAIL_CUSTOMER, we tell Procuret that we would like
# Procuret to send an email to the customer on our behalf inviting them
# to pay using the link.
link = InstalmentLink.create(
supplier=supplier_id,
invoice_amount=Decimal('422.42'),
invitee_email='someone@great-domain.org',
invoice_identifier='T 055',
communication=CommunicationOption.EMAIL_CUSTOMER,
session=session
)
PerspectivePerspective is an enumeration of possible angles from which a client
can engage with Procuret. If you wish to use Procuret services from
the perspective of a Supplier, you will create a Session with the
Perspective.SUPPLIER case.
.SUPPLIER.BUSINESSAn enumeration of possible Session lifecycles - A "short lived" Session will
expire after a period of disuse. A "long lived" Session will never expire,
and must be manually deleted.
Consider opting for a short-lived Session wherever practical, to reduce the
probability of the stored credential being compromised.
.LONG_LIVED.SHORT_LIVEDCommunicationOptionAn enumeration of instructions you can send Procuret in some contexts, to tell it how you wish for it to contact (or not contact) the a customer.
.EMAIL_CUSTOMER - Procuret will contact the customer by email.DO_NOT_CONTACT_CUSTOMER - Procuret will not try to contact the customerPlease contact us anytime at support@procuret.com with any questions. To chat with us less formally, please feel free to tweet @hugh_jeremy.
For more general information about Procuret, please visit procuret.com.
FAQs
Procuret API Library
We found that procuret demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.