Magento Extensions Rating 2024
Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
OauthServiceInterface Interface Reference
Inheritance diagram for OauthServiceInterface:
OauthService

Public Member Functions

 createConsumer ($consumerData)
 
 createAccessToken ($consumerId, $clearExistingToken=false)
 
 getAccessToken ($consumerId)
 
 loadConsumer ($consumerId)
 
 loadConsumerByKey ($key)
 
 postToConsumer ($consumerId, $endpointUrl)
 
 deleteConsumer ($consumerId)
 
 deleteIntegrationToken ($consumerId)
 

Detailed Description

Integration oAuth Service Interface

@api

Since
100.0.2

Definition at line 16 of file OauthServiceInterface.php.

Member Function Documentation

◆ createAccessToken()

createAccessToken (   $consumerId,
  $clearExistingToken = false 
)

Create access token for provided consumer.

Parameters
int$consumerId
bool$clearExistingToken
Returns
bool If token was created

Implemented in OauthService.

◆ createConsumer()

createConsumer (   $consumerData)

Create a new consumer account.

Parameters
array$consumerData- Information provided by an integration when the integration is installed. 
array(
    'name' => 'Integration Name',
    '...' => '...', // Other consumer data can be passed as well
)
Returns
\Magento\Integration\Model\Oauth\Consumer
Exceptions

Implemented in OauthService.

◆ deleteConsumer()

deleteConsumer (   $consumerId)

Delete the consumer data associated with the integration including its token and nonce

Parameters
int$consumerId
Returns
array Consumer data array

Implemented in OauthService.

◆ deleteIntegrationToken()

deleteIntegrationToken (   $consumerId)

Remove token associated with provided consumer.

Parameters
int$consumerId
Returns
bool If token was deleted

Implemented in OauthService.

◆ getAccessToken()

getAccessToken (   $consumerId)

Retrieve access token assigned to the consumer.

Parameters
int$consumerId
Returns
OauthTokenModel|bool Return false if no access token is available.

Implemented in OauthService.

◆ loadConsumer()

loadConsumer (   $consumerId)

Load consumer by its ID.

Parameters
int$consumerId
Returns
\Magento\Integration\Model\Oauth\Consumer
Exceptions

Implemented in OauthService.

◆ loadConsumerByKey()

loadConsumerByKey (   $key)

Load consumer by its key.

Parameters
string$key
Returns
\Magento\Integration\Model\Oauth\Consumer
Exceptions

Implemented in OauthService.

◆ postToConsumer()

postToConsumer (   $consumerId,
  $endpointUrl 
)

Execute post to integration (consumer) HTTP Post URL. Generate and return oauth_verifier.

Parameters
int$consumerId- The consumer Id.
string$endpointUrl- The integration endpoint Url (for HTTP Post)
Returns
string - The oauth_verifier.
Exceptions

Implemented in OauthService.

The documentation for this interface was generated from the following file: