Xcom::getOnboardingURL

(PECL xcommerce >= 1.0.2)

Xcom::getOnboardingURL — Generate an onboarding URL

Description

public string Xcom::getOnboardingURL ( string $capability_name , string $agreement_url )

Generate an onboarding URL which can be given to the user to authorize your capability.

Liste de paramètres

capability_name: The capability name, such as "FooBar Inc.'s Calculator"
agreement_url: A URL to any additional agreements which would be presented to users during the onboarding.

Valeurs de retour

Returns the URL, or FALSE on failure.

Exemples

Exemple #1 Xcom::getOnboardingURL() example


<?php

$xcom = new Xcom(XCOM_FABRIC_SANDBOX, "fabric_token", "capability_token");

var_dump($xcom->getOnboardingURL("Shipping Service", "http://legal.com/bar"));

/*
* Output:
* https://devportal.x.com/go/here
*/
?>