ベアラートークンを必要とするAPIを使用してPythonでAPI呼び出しを行う


98

JSONAPI呼び出しをPythonプログラムに統合するためのヘルプを探しています。

次のAPIをPython.pyプログラムに統合して、APIを呼び出し、応答を出力できるようにすることを検討しています。

APIガイダンスでは、APIの呼び出しを許可するには、ベアラートークンを生成する必要があると記載されていますが、これは正常に実行されました。ただし、このトークンをPythonAPIリクエストのベアラートークン認証として含める構文がわかりません。

トークンを含めたcURLを使用して、上記のリクエストを正常に完了することができます。「urllib」ルートと「requests」ルートを試しましたが、役に立ちませんでした。

APIの詳細:IBM X-Force ExchangeAPIドキュメント-IPレピュテーション

回答:


147

これは、ヘッダーデータのキーとしてそれを期待していることを意味します

import requests
endpoint = ".../api/ip"
data = {"ip": "1.1.2.3"}
headers = {"Authorization": "Bearer MYREALLYLONGTOKENIGOT"}

print(requests.post(endpoint, data=data, headers=headers).json())

上記は次の構文エラーをスローします: Traceback (most recent call last): File "bearerreturn.py", line 6, in <module> print requests.post(endpoint,data=data,headers=headers).json() TypeError: 'dict' object is not callable 以下のコード:import requests endpoint = "https://xforce-api.mybluemix.net:443/api/ip" data = {"ip":"1.1.2.3"} headers = {"Bearer token":"TOKEN WAS INSERTED HERE"} print requests.post(endpoint,data=data,headers=headers).json() アイデアはありますか?
user4657 2015

古いバージョンのリクエストjsonがあります...バージョンのdictであり、関数ではありませんrequests.post(...).json ...呼び出さないでください
Joran Beasley 2015

JoranBeasleyに感謝します。pipを介してRequestsライブラリを更新しました。これにより、元の構文を維持できました。ただし、上記を実行すると、次の.json応答が出力されます。 {u'error': u'Not authorized. Access is only allowed via https://exchange.xforce.ibmcloud.com/#/'} これは、ブラウザーでURLを直接ヒットした場合と同じです。トークンまたはエンドポイントの構成方法で何かが不足していますか?コード:import requests endpoint = "https://xforce-api.mybluemix.net:443/ipr/" data = {"ip":"1.1.2.3"} headers = {"Bearer token":"TOKEN_HERE"} print requests.post(endpoint,data=data,headers=headers).json()
user4657 2015

残念ながら、私はそれを本当に助けることはできません...それは悪いエンドポイントであるか、あなたの資格情報が無効です(あなたは彼らのURLに対してのみ設定されている彼らのサンプルトークンを使用していますか?)またはおそらくあなたは彼らのdeleoperにあなたのアプリのURLを置く必要がありますコードのパネル...それが最初のトークンである可能性があります...トークンを更新トークンと交換する必要があります。これを使用して、より永続的なトークンを取得できます(少なくとも、oauth2の通常の動作方法です。)
Beasley

おっとルックスは、私が持っていたように、ヘッダ間違っは更新されたコード試す
Joranビーズリー

55

requestsモジュールを使用している場合、別のオプションは、「新しい認証形式」で説明されているように、認証クラスを作成することです。

import requests

class BearerAuth(requests.auth.AuthBase):
    def __init__(self, token):
        self.token = token
    def __call__(self, r):
        r.headers["authorization"] = "Bearer " + self.token
        return r

そして、あなたはこのようなリクエストを送ることができますか

response = requests.get('https://www.example.com/', auth=BearerAuth('3pVzwec1Gs1m'))

これによりauth、基本認証と同じ引数を使用でき、特定の状況で役立つ場合があります。


これはzeepでも役立つかもしれません。これはrequests.authタイプの認証を使用します(
SOAP

20

トークンは、次の形式に従ってAuthorizationヘッダーに配置する必要があります。

承認:ベアラー[Token_Value]

以下のコード:

import urllib2
import json

def get_auth_token():
    """
    get an auth token
    """
    req=urllib2.Request("https://xforce-api.mybluemix.net/auth/anonymousToken")
    response=urllib2.urlopen(req)
    html=response.read()
    json_obj=json.loads(html)
    token_string=json_obj["token"].encode("ascii","ignore")
    return token_string

def get_response_json_object(url, auth_token):
    """
    returns json object with info
    """
    auth_token=get_auth_token()
    req=urllib2.Request(url, None, {"Authorization": "Bearer %s" %auth_token})
    response=urllib2.urlopen(req)
    html=response.read()
    json_obj=json.loads(html)
    return json_obj

python3の場合:req = urllib.request.Request(urlstr, None, {"Authorization": "Bearer %s" % enc_authstr}) response = urllib.request.urlopen(req)
SidJ

0

これは、cURLとPythonでの実装の完全な例です-承認とAPI呼び出しを行うため

カール

1.承認

次のようなアクセスデータを受け取りました。

Username: johndoe

Password: zznAQOoWyj8uuAgq

Consumer Key: ggczWttBWlTjXCEtk3Yie_WJGEIa

Consumer Secret: uuzPjjJykiuuLfHkfgSdXLV98Ciga

このようにcURLで呼び出すことができます:

curl -k -d "grant_type=password&username=Username&password=Password" \

                    -H "Authorization: Basic Base64(consumer-key:consumer-secret)" \

                       https://somedomain.test.com/token

または、この場合は次のようになります。

curl -k -d "grant_type=password&username=johndoe&password=zznAQOoWyj8uuAgq" \

                    -H "Authorization: Basic zzRjettzNUJXbFRqWENuuGszWWllX1iiR0VJYTpRelBLZkp5a2l2V0xmSGtmZ1NkWExWzzhDaWdh" \

                      https://somedomain.test.com/token

答えは次のようになります。

{
    "access_token": "zz8d62zz-56zz-34zz-9zzf-azze1b8057f8",
    "refresh_token": "zzazz4c3-zz2e-zz25-zz97-ezz6e219cbf6",
    "scope": "default",
    "token_type": "Bearer",
    "expires_in": 3600
}

2.APIの呼び出し

上記の認証を使用するAPIを呼び出す方法は次のとおりです。Limitおよびoffsetは、APIが実装できる2つのパラメーターの単なる例です。access_token上から挿入する必要があり"Bearer "ます。したがって、上からの認証データを使用してAPIを呼び出す方法は次のとおりです。

curl -k -X GET "https://somedomain.test.com/api/Users/Year/2020/Workers?offset=1&limit=100" -H "accept: application/json" -H "Authorization: Bearer zz8d62zz-56zz-34zz-9zzf-azze1b8057f8"

Python

Pythonで実装された上記と同じもの。コードをコピーして貼り付けることができるように、コメントにテキストを入れました。

# Authorization data

import base64
import requests

username = 'johndoe'
password= 'zznAQOoWyj8uuAgq'
consumer_key = 'ggczWttBWlTjXCEtk3Yie_WJGEIa'
consumer_secret = 'uuzPjjJykiuuLfHkfgSdXLV98Ciga'
consumer_key_secret = consumer_key+":"+consumer_secret
consumer_key_secret_enc = base64.b64encode(consumer_key_secret.encode()).decode()

# Your decoded key will be something like:
#zzRjettzNUJXbFRqWENuuGszWWllX1iiR0VJYTpRelBLZkp5a2l2V0xmSGtmZ1NkWExWzzhDaWdh


headersAuth = {
    'Authorization': 'Basic '+ str(consumer_key_secret_enc),
}

data = {
  'grant_type': 'password',
  'username': username,
  'password': password
}

## Authentication request

response = requests.post('https://somedomain.test.com/token', headers=headersAuth, data=data, verify=True)
j = response.json()

# When you print that response you will get dictionary like this:

    {
        "access_token": "zz8d62zz-56zz-34zz-9zzf-azze1b8057f8",
        "refresh_token": "zzazz4c3-zz2e-zz25-zz97-ezz6e219cbf6",
        "scope": "default",
        "token_type": "Bearer",
        "expires_in": 3600
    }

# You have to use `access_token` in API calls explained bellow.
# You can get `access_token` with j['access_token'].


# Using authentication to make API calls   

## Define header for making API calls that will hold authentication data

headersAPI = {
    'accept': 'application/json',
    'Authorization': 'Bearer '+j['access_token'],
}

### Usage of parameters defined in your API
params = (
    ('offset', '0'),
    ('limit', '20'),
)

# Making sample API call with authentication and API parameters data

response = requests.get('https://somedomain.test.com/api/Users/Year/2020/Workers', headers=headersAPI, params=params, verify=True)
api_response = response.json()

@KurtPetersあなたのコメントはOPの質問とは何の関係もありません。私の答えは彼の場合には完璧に機能します。
ハーベイ
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.