Ebay OAuth 2 Generate Token and Refresh – PHP

31 Comments

1. I have changed “&amp” to “&” in CURLOPT_POSTFIELDS, add PHP function “urlencode” before all POST data (for example:
   urlencode($this->authCode)
   scope=”.urlencode(“https…
   )
   and now works perfect.

2. @Piotr yes sorry the code editor change some html char. For the urlencode i don’t use it and work. Thank you for the suggest!

3. Wow this is very useful article keep it up thanks..

4. how to call firstAuthAppToken();

5. First when? What do you mean?

6. Thanks for reply. But i want to know that’s when this method to be call. Method name – ” firstAuthAppToken()”

   public function firstAuthAppToken() {
   $url = “https://auth.ebay.com/oauth2/authorize?client_id=”.$this->clientID.”&response_type=code&redirect_uri=”.$this->ruName.”&scope=https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly“;
   }

7. Okay i have understand.
   In the function you must to add:

   public function firstAuthAppToken() {
   $url = “https://auth.ebay.com/oauth2/authorize?client_id=”.$this->clientID.”&response_type=code&redirect_uri=”.$this->ruName.”&scope=https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly“;
   return $url;
   }

   You can create a php file, in witch you can call this function, so this function generate to you an url, you must to copy and paste this in the url bar of your browser, and then when redirect you back, in the url you can see the auth token, that you must to copy and paste in you database.
   Or you can simply generate a php redict page, that take a $_GET token param and save it in you database.

8. You need to add (PHP 7.0.7+):

   curl_setopt($ch, CURLHEADER_SEPARATE, true);

9. Thank you! i’have added it

10. may help someone: https://github.com/michabbb/ebay-oauth-playground

11. This is a stupid question sorry!

    I have got to the point where I have my authorisation code

    Where do I run the curl request from? And where should the authorisation code and ruName go?

    Thanks!

12. SUPER IMPORTANT:

    in case u want to call “old apis” (like shopping API) via OAuth, this whole blog entry does not work for you, because you DONT need a “user access token”, you need an “application access token” – a total different thing 😉

    https://developer.ebay.com/api-docs/static/oauth-token-types.html

    read here how to get one:

    https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html

    the “application access token” is NOT connected to a user’s Ebay account and has NO refresh token.

13. @Anne the ruName is the “Ebay redirect url name” like in the screenshot “Lenny_Rice_Book-LennyRic-“, and you must to insert that string.

14. @micha thank you 😉

15. HOw to login using php curl in ebay???

16. Need assistance in switching eBay Shopping API to OAuth authorization in our php application.

    We are looking for somebody with experience to help us in converting ebay shopping API to use oauth application access token
    I need step by step guide on how to change the APPID based calls to Oauth.

    Here is actual code (using the shopping API call) from our php application:

    function eBay_API($app, $data, $api_type = 0, $sandbox = 0)
    {
    // using shopping api
    if ($api_type == 1)
    {
    $header = array(
    ‘X-EBAY-API-VERSION:829’,
    ‘X-EBAY-API-APP-ID:APP_ID_HERE’,
    ‘X-EBAY-API-CALL-NAME:’.$app,
    ‘X-EBAY-API-REQUEST-ENCODING:XML’,
    ‘X-EBAY-API-SITE-ID:0’,
    ‘Content-Type: text/xml;charset=utf-8’,
    );
    if ($sandbox)
    $api_url = “http://open.api.sandbox.ebay.com/shopping?”;
    else
    $api_url = “http://open.api.ebay.com/shopping?”;
    }
    // using trading api
    else
    {
    $header = array(
    ‘X-EBAY-API-COMPATIBILITY-LEVEL:811’,
    ‘X-EBAY-API-DEV-NAME:DEV_NAME’,
    ‘X-EBAY-API-APP-NAME:APP_NAME’,
    ‘X-EBAY-API-CERT-NAME:CERT_NAME’,
    ‘X-EBAY-API-CALL-NAME:’.$app,
    ‘X-EBAY-API-SITEID:0’,
    );
    if ($sandbox)
    $api_url = “https://api.sandbox.ebay.com/ws/api.dll”;
    else
    $api_url = “https://api.ebay.com/ws/api.dll”;
    }

    $ch = curl_init($api_url);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    $output = curl_exec($ch);
    curl_close($ch);

    return $output;
    }

    thanks
    Yasir
    yasir.ikram@greencitizen.com

17. Wow, what a great lesson. But, tutor how can i get application access token for shopping api.Please any help wll be grateful. Thanks very much.please share a link if you have any tutorial on that.

18. Please that is my code that i copy and used. But it is not working. i do get the response “This site can’t be reachedlocalhost refused to connect.
    Try:

    Checking the connection
    Checking the proxy and the firewall
    ERR_CONNECTION_REFUSED”

    What I my missing. Any answer wll be grately be appreciated. Thanks.

    devID = ‘e87b5af6-d1a2-463b-a522-128d4c884282’; // these prod keys are different from sandbox keys
    $this->appID = ‘beltamon-belta-PRD-31a11534d-138e8be6’;
    $this->certID = ‘PRD-1a11534d7711-39da-4274-ac8d-5a06’;
    $this->clientID = ”;
    //set the Server to use (Sandbox or Production)
    $this->serverUrl = ‘https://api.ebay.com/ws/api.dll’; // server URL different for prod and sandbox
    //the token representing the eBay user to assign the call with

    $this->authCode = ‘https://signin.ebay.com/ws/eBayISAPI.dll?ThirdPartyAuthSucessFailure&isAuthSuccessful=true&code=v%5E1.1%23i%5E1%23r%5E1%23p%5E3%23I%5E3%23f%5E0%23t%5EUl41XzQ6Qjg4RTYzMUVCN0EyRDFGN0RGOEJEQTU1RDZBMURCNkJfMF8xI0VeMjYw&expires_in=299’;
    $this->authToken =””;
    $this->refreshToken =””;
    $this->ruName= “belta_monic-beltamon-belta–ixtnzo”;

    $this->paypalEmailAddress= ”;

    }

    public function firstAuthAppToken() {
    $url = “https://auth.ebay.com/oauth2/authorize?client_id=”.$this->clientID.”&response_type=code&redirect_uri=”.$this->ruName.”&scope=https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly“;
    return $url;
    }

    public function authorizationToken()
    {
    $link = “https://api.ebay.com/identity/v1/oauth2/token”;
    $codeAuth = base64_encode($this->clientID.’:’.$this->certID);
    $ch = curl_init($link);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    ‘Content-Type: application/x-www-form-urlencoded’,
    ‘Authorization: Basic ‘.$codeAuth
    ));
    curl_setopt($ch, CURLHEADER_SEPARATE, true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, “grant_type=authorization_code&code=”.$this->authCode.”&redirect_uri=”.$this->ruName);
    $response = curl_exec($ch);
    $json = json_decode($response, true);
    $info = curl_getinfo($ch);
    curl_close($ch);
    if($json != null)
    {
    $this->authToken = $json[“access_token”];
    $this->refreshToken = $json[“refresh_token”];
    }
    }

    public function refreshToken()
    {
    $link = “https://api.ebay.com/identity/v1/oauth2/token”;
    $codeAuth = base64_encode($this->clientID.’:’.$this->certID);
    $ch = curl_init($link);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    ‘Content-Type: application/x-www-form-urlencoded’,
    ‘Authorization: Basic ‘.$codeAuth
    ));
    echo $this->refreshToken;
    curl_setopt($ch, CURLHEADER_SEPARATE, true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, “grant_type=refresh_token&refresh_token=”.$this->refreshToken.”&scope=https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly“);
    $response = curl_exec($ch);
    $json = json_decode($response, true);
    $info = curl_getinfo($ch);
    curl_close($ch);
    if($json != null)
    {
    $gg = $this->authToken = $json[“access_token”];
    echo $gg;
    }
    }
    }

    ?>

19. Is it possible to use above class in REST API to connect eBay ?
    I am getting below response

    jSON response
    (
    [error] => invalid_client
    [error_description] => client authentication failed
    )

20. It is working properly. Great tutorial, thank you very much.

21. Hi Francesco !
    Very helpfull post.
    Just a question:
    How I can use this function
    public function firstAuthAppToken() {
    $url = “https://auth.ebay.com/oauth2/authorize?client_id=”.$this->clientID.”&response_type=code&redirect_uri=”.$this->ruName.”&scope=https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly“;
    return $url;
    }

    for automate the creation of the authorization code every 18 months ?
    I have tried with file_get_contents() urlencoding the scope contents (due to spaces) without success

22. Hi, Great detailed post but I think I must be missing a key element. I have created my php script with your “At the end my eBay API Simple Class” and changed all of values required for my ebay account but I am not getting any token returned nor any errors!
    Is it a simple case of making a php file and pasting the code into it or do I need to have some code to trigger the functions?

    Thanks for any guidance provided.

23. I have some response (I guess some parameters are wrong or missing):
    array(2) {
    [“error”]=>
    string(13) “invalid_grant”
    [“error_description”]=>
    string(80) “the provided authorization grant code is invalid or was issued to another client”
    }
    array(2) {
    [“error”]=>
    string(14) “invalid_client”
    [“error_description”]=>
    string(28) “client authentication failed”
    }
    array(2) {
    [“error”]=>
    string(22) “unsupported_grant_type”
    [“error_description”]=>
    string(66) “grant type in request is not supported by the authorization server”
    }

24. Please help me to fix the invalid scope issue in eBay OAuth Token Using Refresh Token API. I am in production Mode. Even not the primary scope https://api.ebay.com/oauth/api_scope is working for me. I am using PHP.

    $curlSecondHandler = curl_init();

    curl_setopt_array($curlSecondHandler, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => “grant_type=refresh_token&refresh_token=”.$refreshToken.”&scope=”.urlencode($scopes),
    CURLOPT_HTTPHEADER => [
    ‘Content-Type: application/x-www-form-urlencoded’,
    ‘Authorization: Basic ‘ . base64_encode($clientId . ‘:’ . $certId)
    ],
    ]);

25. Hello.
    I followed the simple instructions provided, created an auth code and copied from the url (including the code=? (I tried with and without just in case, seemed like an error to me).
    For $response I get “the provided authorization grant code is invalid or was issued to another client”

    Any idea what’s wrong? these are the fields I filled, did I miss anything?

    $this->devID = ‘aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee’;
    $this->appID = ‘MyName-1111-2222-3333-444444444444’;
    $this->certID = ‘aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee’;
    $this->clientID = ‘MyName-1111-2222-3333-444444444444’; // The same as devID?!?!
    //set the Server to use (Sandbox or Production)
    $this->serverUrl = ‘https://api.ebay.com/ws/api.dll’; // server URL different for prod and sandbox
    //the token representing the eBay user to assign the call with

    $this->authCode = ‘code=v%5E1.1……………………………………………………………………………………………….Ab’;
    $this->authToken =””;
    $this->refreshToken =””;
    $this->ruName= “My_Name-MyName-11a1-1-abcdefg”;

    $this->paypalEmailAddress= ‘my@email.com’;

    Thanks!

26. Hi, when i make the request:
    authorizationToken()

    response is bool(false),

    can someOne help me?

27. Hi Denis,
    yes it’s correct because set the 2 variable:

    if($json != null)
    {
    $this->authToken = $json[“access_token”];
    $this->refreshToken = $json[“refresh_token”];
    }

    if you want you can put a return $this;

28. Hi, before I ask you some things about your script I was wondering if I can automate the upload of products from a website to Ebay via API without a user interaction (like the “Sign in for OAuth”).
    I’m Italian so if you want to contact me via email I’d like to ask you some infos 🙂
    Thanks!

29. thanks for share your class,
    it is very clear and very useful

    but i get this error
    invalid_grant”,”error_description”:”the provided authorization grant code is invalid or was issued to another client

    maybe I’m wrong login?
    which account should i log in with on ebay in link obtained with firstAuthAppToken method
    I currently have 2 accounts, developer and personal
    developer not work for login, I log with personal account
    is correctly?

    I don’t think there are any other errors
    thanks a lot

30. Thank you, works fine! 🙂

31. Has anyone been able to get the password for sFTP access via OAuth token? As per the instructions on their Merchant Integration Platform User Guide, it says that for the password Use an OAuth token (preferred option). To generate, or mint, access tokens, see Using OAuth to access eBay APIs:

    https://developer.ebay.com/devzone/merchant-products/mipng/user-guide-en/default.html#advanced-features.html?TocPath=_____9

    I am able to generate the token via client_credentials but the token is used as a password it says “Access Denied”

    Any help to get this working will be greatly appreciated