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 PartnerAPIOperationRenewCertificate

This class represents the renewCertificate WSDL operation.

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

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

The constructor.

The constructor.

It initializes input and output data.

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 PartnerAPIOperationRenewCertificate
# 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

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# setCustomer( string $customer )

Sets a customer name for the request.

Sets a customer name for the request.

Setting this value is required.

Parameters

$customer
string
$customer

Returns

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# setProductCode( string $productCode )

Sets a product code for the request.

Sets a product code for the request.

Setting this value is required.

Parameters

$productCode
string
$productCode

Returns

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# setSerialNumber( string $serialNumber )

Sets the serial number of a certificate to be renew.

Sets the serial number of a certificate to be renew.

It is required to set X509Cert or serialNumber value but only one of them may be set. Setting both values is an error.

Parameters

$serialNumber
string
$serialNumber

Returns

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# setX509Cert( string $x509cert )

Sets a certificate to be renew.

Sets a certificate to be renew.

It is required to set X509Cert or serialNumber value but only one of them may be set. Setting both values is an error.

Parameters

$x509cert
string
$x509cert

Returns

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# setHashAlgorithm( string $hashAlgorithm )

Sets a hash algorithm to be used.

Sets a hash algorithm to be used.

Parameters

$hashAlgorithm
string
$hashAlgorithm

Returns

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# setUserAgent( string $userAgent )

Sets the userAgent for the request

Sets the userAgent for the request

Parameters

$userAgent
string
$userAgent

Returns

PartnerAPIOperationRenewCertificate
public PartnerAPIOperationRenewCertificate
# 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

PartnerAPIOperationRenewCertificate
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 string
# getOrderID( )

Gets an order ID returned in a response.

Gets an order ID returned in a response.

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 PartnerAPIMessageRenewCertificateResponse
# getResponseMessage( )

A complete response from a service

A complete response from a service

Returns

PartnerAPIMessageRenewCertificateResponse
Properties summary
protected PartnerAPIMessageRenewCertificate $_input NULL
#
protected PartnerAPIMessageRenewCertificateResponse $_output NULL
#
protected string $_operation 'renewCertificate'
#
Properties inherited from PartnerAPIOperation
$_service
API documentation generated by ApiGen 2.8.0