23

I am a beginner to magento REST API, how i will get token and token secret to be fill in Postman REST resquest. I have only consumer key and consumer secret. Please provide me the steps to follow.

Holistic Developer
  • 2,458
  • 1
  • 18
  • 27
Deepak Kumar
  • 357
  • 1
  • 2
  • 8

3 Answers3

69

First, you want to request a valid OAuth token and secret. Do this by hitting the /oauth/initiate URL of your Magento store with a GET parameter for oauth_callback. We're going to use httpbin so that we can echo anything that is passed to our callback. Make sure you have "Auto add parameters" checked on the OAuth 1.0 settings for Postman.

OAuth Token Request

That will give you an oauth_token and oauth_token_secret, which are only temporary. These are referred to as a "request token" and secret. Save these values somewhere because you will need them later.

OAuth Token Response

Now, assemble a new regular HTTP request to the /admin/oauth_authorize URL of your Magento store. This will return a login form where you can accept the oauth token and authorize your app, however since we're using Postman we aren't able to interact with the form.

OAuth Authorization Form

Instead, view the source and pull out the form_key hidden input value. Then assemble a new HTTP request to fake the submission of the authorization form. Make sure it is a POST request. Your new HTTP request should look like this.

OAuth Authorization Form Submit

Now, you need to actually confirm the authorization. Simply issue a GET to the /admin/oauth_authorize/confirm URL of your Magento store with the oauth_token as your parameter. When you send this request it will redirect to your oauth_callback from the first step. Now, you can see why we used httpbin as our callback in the first step.

OAuth Authorization Confirmation

OK. So, we're almost home. The last piece of the puzzle is to use the oauth_token, oauth_secret, and oauth_verifier all together to get a valid and persistent "access token". So, take the oauth_token_secret from the first step, and combine and assemble a new OAuth request like so.

OAuth Token

You should get a returned token and secret. These will never expire! You can use them to query products and stuff.

OAuth Token Response

Now, you can assemble your OAuth requests like this. Edit: Note, you must check the "Add params to header" checkbox in order for Magento REST calls to work properly.

OAuth REST Request

Franklin P Strube
  • 2,215
  • 18
  • 12
  • 1
    Thanks a million... Exactly what I need to start requesting the Magento REST API! – Sebastian Buckpesch Feb 09 '15 at 13:05
  • @Franklin P Strube I am accessing it from an iOS app. Is this the right way to bypass the login window in step 2 (fetching the form_key)? I dont want the user to type in the username and password – nr5 Nov 30 '15 at 07:45
  • This answer was incredibly helpful. The Magento API documentation is rather loose and only covers basic information. – ThisDarkTao May 05 '16 at 07:52
  • Hi...can u help me with the same process in magento 2.1....Rest api oauth – Gowsik Sep 02 '16 at 06:33
  • Hi, I'm getting a bit stuck on the 4th step of the guide "Instead, view the source and pull out the form_key hidden input value. Then assemble a new HTTP request to fake the submission of the authorization form" - If I do this, it doesn't accept the form_key value, tells me that it's invalid. – Thomas Harding May 02 '17 at 16:19
  • It looks like the current version of Postman (5.5.0) doesn't properly handle `oauth_verifier` when signing the request for the access token. There's is an [open issue](https://github.com/postmanlabs/postman-app-support/issues/283) for it. – Holistic Developer Jan 11 '18 at 20:28
  • Thanks a lot this provided me the details and it was clearly explained.. Just following what ever is mentioned here got me the things working.. – Bala Sivagnanam Feb 12 '18 at 04:26
  • In Step 2 I had to use /oauth/authorize instead of /admin/oauth_authorize – Mike W Apr 16 '18 at 13:46
6

Example request in Postman version 6.x.x

image.png

And response of this request is

image.png

You can get this credentials from Magento Admin. Click on edit icon in Integrations page.

image.png

Farid Movsumov
  • 12,350
  • 8
  • 71
  • 97
2

@Franklin P Strube Unfortunately, I don't have enough reputations to add a comment.

I would like to add the following. The Magento REST API does not require both outh params on the URL AND Oauth headers. This is not actually stated above. See the last note where it says you need to "add params to header". You do need to do this, but when you do you will find it sends both url params and oauth headers. You don't need the url parms, it will work fine without them. btw: the franklin response worked great!

mancocapac
  • 812
  • 6
  • 23