Overview

Packages

  • exceptions
  • messages
  • operations
  • PHP
  • service
  • types

Classes

  • PartnerAPIError
  • PartnerAPIOperation
  • PartnerAPIOperationAddEmailVerification
  • PartnerAPIOperationAddSanVerification
  • PartnerAPIOperationCancelOrder
  • PartnerAPIOperationGetCertificate
  • PartnerAPIOperationGetEmailVerification
  • PartnerAPIOperationGetExpiringCertificates
  • PartnerAPIOperationGetModifiedOrders
  • PartnerAPIOperationGetOrderByOrderID
  • PartnerAPIOperationGetOrdersByDateRange
  • PartnerAPIOperationGetOrderState
  • PartnerAPIOperationGetProductList
  • PartnerAPIOperationGetSanVerificationState
  • PartnerAPIOperationModifySNICertificate
  • PartnerAPIOperationOrderSNICertificate
  • PartnerAPIOperationPerformSanVerification
  • PartnerAPIOperationQuickOrder
  • PartnerAPIOperationReissueCertificate
  • PartnerAPIOperationRenewCertificate
  • PartnerAPIOperationRevokeCertificate
  • PartnerAPIOperationValidateOrderParameters
  • PartnerAPIOperationVerifyOrder
  • Overview
  • Package
  • Class
  • Tree

Class PartnerAPIOperationQuickOrder

This class represents the quickOrder WSDL operation.

It is based on the PartnerAPIOperation class and derives some properties and methods from that class.

PartnerAPIOperation
Extended by PartnerAPIOperationQuickOrder
Package: operations
Copyright: Copyright (c) 2020 Asseco Data Systems SA
License: license.txt
Located at certumPartnerAPI/operations/operationQuickOrder.php
Methods summary
public
# __construct( )

The constructor.

The constructor.

It initializes input and output data.

public PartnerAPIOperationQuickOrder
# setCSR( string $csr )

Sets a CSR for the request.

Sets a CSR for the request.

Setting this value is required.

Parameters

$csr
string
$csr

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setCustomer( string $customer )

Sets a customer name.

Sets a customer name.

Setting this value is required.

Parameters

$customer
string
$customer

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setLanguage( string $lang )

Sets a language to be used for e-mails.

Sets a language to be used for e-mails.

Default is 'pl'. Also acceptable are 'en' and 'ru'.

Parameters

$lang
string
$lang

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setOrderID( string $id )

Sets an order identificator.

Sets an order identificator.

If not set it will be generated automatically by the system. This identificator have to be unique and it is used to refer to the request.

Parameters

$id
string
$id

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setProductCode( string $code )

Sets a three-letter product code.

Sets a three-letter product code.

Setting this value is required.

Parameters

$code
string
$code

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setUserAgent( string $userAgent )

Sets a string identifying web browser and operating system.

Sets a string identifying web browser and operating system.

Parameters

$userAgent
string
$userAgent

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setHashAlgorithm( string $hashAlgorithm )

Sets a hash algorithm for a certificate.

Sets a hash algorithm for a certificate.

Parameters

$hashAlgorithm
string
$hashAlgorithm

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setEmail( string $email )

Sets an email for a SSL certificate.

Sets an email for a SSL certificate.

Parameters

$email
string
$email

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setRequestorInfo( string $firstName, string $lastName, string $email, string $phone )

Sets all the contact data of a requestor.

Sets all the contact data of a requestor.

All arguments are required apart from the last which can be NULL.

Parameters

$firstName
string
$firstName
$lastName
string
$lastName
$email
string
$email
$phone
string
$phone

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setOrganizationInfo( string $taxNumber )

Sets an organization information.

Sets an organization information.

It is not required to set organization information but if you need or have to set it all the arguments are required.

Parameters

$taxNumber
string
$taxNumber The tax identification number

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setCommonName( string $commonName )

Sets an overrided CSR commonName.

Sets an overrided CSR commonName.

It is not required to set this but if you need to override a commonName from CSR then you have to change this as same as SAN entries and approvers.

Parameters

$commonName
string
$commonName The commonName to override CN given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setOrganization( string $organization )

Sets an overrided CSR organization.

Sets an overrided CSR organization.

It is not required to set this but if you need to override a organization from CSR use this method.

Parameters

$organization
string
$organization The organization to override O given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setOrganizationalUnit( string $organizationalUnit )

Sets an overrided CSR organizational unit.

Sets an overrided CSR organizational unit.

It is not required to set this but if you need to override a organizational unit from CSR use this method.

Parameters

$organizationalUnit
string
$organizationalUnit The Organizational Unit to override OU given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setLocality( string $locality )

Sets an overrided CSR locality.

Sets an overrided CSR locality.

It is not required to set this but if you need to override a locality from CSR use this method.

Parameters

$locality
string
$locality The locality to override L given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setCountry( string $country )

Sets an overrided CSR country.

Sets an overrided CSR country.

It is not required to set this but if you need to override a country from CSR use this method.

Parameters

$country
string
$country The country to override C given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setState( string $state )

Sets an overrided CSR state.

Sets an overrided CSR state.

It is not required to set this but if you need to override a state from CSR use this method.

Parameters

$state
string
$state The state to override state given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setSerialNumber( string $serialNumber )

Sets an overrided CSR serialNumber.

Sets an overrided CSR serialNumber.

It is not required to set this but if you need to override a serialNumber from CSR use this method.

Parameters

$serialNumber
string
$serialNumber The serialNumber to override serialNumber given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setBusinessCategory( string $businessCategory )

Sets an overrided CSR businessCategory.

Sets an overrided CSR businessCategory.

It is not required to set this but if you need to override a businessCategory from CSR use this method.

Parameters

$businessCategory
string
$businessCategory The businessCategory to override businessCategory given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setStreetAddress( string $streetAddress )

Sets an overrided CSR streetAddress.

Sets an overrided CSR streetAddress.

It is not required to set this but if you need to override a streetAddress from CSR use this method.

Parameters

$streetAddress
string
$streetAddress The streetAddress to override streetAddress given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setPostalCode( string $postalCode )

Sets an overrided CSR postalCode.

Sets an overrided CSR postalCode.

It is not required to set this but if you need to override a postalCode from CSR use this method.

Parameters

$postalCode
string
$postalCode The postalCode to override postalCode given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setJoiln( string $joiln )

Sets an overrided CSR joiln.

Sets an overrided CSR joiln.

It is not required to set this but if you need to override a joiln from CSR use this method.

Parameters

$joiln
string
$joiln The joiln to override joiln given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setJoisopn( string $joisopn )

Sets an overrided CSR joisopn.

Sets an overrided CSR joisopn.

It is not required to set this but if you need to override a joisopn from CSR use this method.

Parameters

$joisopn
string
$joisopn The joisopn to override joisopn given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setJoisocn( string $joisocn )

Sets an overrided CSR joisocn.

Sets an overrided CSR joisocn.

It is not required to set this but if you need to override a joisocn from CSR use this method.

Parameters

$joisocn
string
$joisocn The joisocn to override joisocn given in CSR

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setRevocationContactEmail( string $revocationContactEmail )

Sets a revocation contact email.

Sets a revocation contact email.

It is not required to set this but if your certificate needs to be revoked we will contact you using provided email.

Parameters

$revocationContactEmail
string
$revocationContactEmail Contact email used in certificate's revocation process

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setShortenedValidityPeriod( string $shortenedValidityPeriod )

Sets a shortened validity period.

Sets a shortened validity period.

It is not required to set this unless you want your certificate to be valid less days than the product allows. In that case please specify your requested certificate's expiration date within product's allowed validity range.

Parameters

$shortenedValidityPeriod
string
$shortenedValidityPeriod Custom certificate's expiration date

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# addSANEntry( string|string[] $domain )

Adds a domain name as a SAN entry in a certificate.

Adds a domain name as a SAN entry in a certificate.

SAN entries are optional. If given, the $domain argument must be a correct domain name or an array of such domain names.

Parameters

$domain
string|string[]
$domain

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setApproverMethod( string $approverMethod )

Sets the approverMethod option for SANApprover.

Sets the approverMethod option for SANApprover.

This option determines which approve method will be used for domain verification.

Parameters

$approverMethod
string
$approverMethod

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setApproverEmail( string $approverEmail )

Sets the approverEmail option for SANApprover.

Sets the approverEmail option for SANApprover.

This option determines where will be sent e-mail with instructions for FILE or DNS approve method. This method cannot be used with EMAIL approve method.

Parameters

$approverEmail
string
$approverEmail

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setApproverEmailPrefix( string $approverEmailPrefix )

Sets the approverEmailPrefix option for SANApprover.

Sets the approverEmailPrefix option for SANApprover.

This option determines which e-mail prefix will be used for EMAIL approve method. This method cannot be used with FILE or DNS approve method.

Parameters

$approverEmailPrefix
string
$approverEmailPrefix

Returns

PartnerAPIOperationQuickOrder
public PartnerAPIOperationQuickOrder
# setVerificationNotificationEnabled( boolean $yes_or_no )

Sets the verificationNotificationEnabled option for SANApprover.

Sets the verificationNotificationEnabled option for SANApprover.

This option determines if verification e-mails for all approvers will be sent or not.

Parameters

$yes_or_no
boolean
$yes_or_no

Returns

PartnerAPIOperationQuickOrder
public string
# getOrderID( )

Gets an order ID returned in a response.

Gets an order ID returned in a response.

Notice: this method returns the order ID returned in a response, not the order ID set for the request. If an order ID has been set, it will be returned in a response, but if it was not set, a new generated order ID will be returned.

Returns

string
public PartnerAPITypeSanVerification
# getSANVerification( )

Returns SANVerification entity containing verification data from a response.

Returns SANVerification entity containing verification data from a response.

If there is no verification in the response a NULL is returned.

Returns

PartnerAPITypeSanVerification
Methods inherited from PartnerAPIOperation
call(), getErrorTexts(), getErrors(), getInputDataAsArray(), getOutputDataAsArray(), getResponseHeader(), getResponseMessage(), getResponseTimeLocal(), getService(), isSuccess(), setService()
Magic methods summary
public PartnerAPIMessageQuickOrderResponse
# getResponseMessage( )

A complete response from a service

A complete response from a service

Returns

PartnerAPIMessageQuickOrderResponse
Properties summary
protected PartnerAPIMessageQuickOrder $_input NULL
#
protected PartnerAPIMessageQuickOrderResponse $_output NULL
#
protected string $_operation 'quickOrder'
#
Properties inherited from PartnerAPIOperation
$_service
API documentation generated by ApiGen 2.8.0