将此 curl 转换为 Python 请求

Question

I was hoping someone can help me translate this curl request into the syntax using Python requests library. This API is supposed to provide me with a list of tickets. I am unfamiliar making a request with headers and an API key in Python so I would appreciate the help. Thank you. I was also getting a 403 Status code when trying to use the base URI.

curl request - changed sensative information.

curl -X POST \
  --url 'https://api.myapi.io/v2/apps/mine/xxx123/data/ticket/search' \
  -H 'x-api-key: myapiKEY123'\
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  --data-raw '{
  "startDate": "2021-03-01",
  "endDate": "2021-04-12"
}'

python code currently

import json
import requests

API_KEY = "myapiKEY123"
client_ID = 'xxx123'
url = '/v2/apps/mine/' + client_ID + '/data/ticket/search'
params = dict(key=API_KEY, lang='en-es')

requestObject = requests.get(
    url, params=params, headers=headers)
print(requestObject.status_code, requestObject.reason)

Current Error Message:

requests.exceptions.MissingSchema: Invalid URL '/v2/apps/mine/xxx123/data/ticket/search': No schema supplied. Perhaps you meant http:///v2/apps/mine/xxx123/data/ticket/search?

Answer 1

You don't have a schema (http/https) on your URL, which is also not a complete URL:

import requests

api_key = "myapiKEY123"
client_id = 'xxx123'
url = f'https://api.myapi.io/v2/apps/mine/{client_id}/data/ticket/search'

headers = {
    'x-api-key': api_key,
    'Accept': 'application/json',
    'Content-type': 'application/json',
}
data = {
    'startDate': '2021-03-01',
    'endDate': '2021-04-12',
}

response = requests.get(url, data=data, headers=headers, timeout=10)

response.raise_for_status()

Then either print the response as JSON (if they're responding with JSON, which is probable) like response.json() or as text response.text . The response.raise_for_status() will check if the status code indicated a failure (eg the response code was a 400-599 ) and raise an exception with the status code and the error.

You're also not passing the API key in the format the curl is suggesting, which I fixed above. I also added a timeout, because note that the requests library does not have a timeout by default, so if the server misbehaves the connection will block forever which is not good.

I also doubt you're supposed to be passing the start and end date as query parameters rather than as data in the body of the request, so I've made that update as well. Using params would result in a request that looked like this:

https://api.myapi.io/v2/apps/mine/{client_ID}/data/ticket/search?startDate=2021-03-01&endDate=2021-04-12

When what the curl (and my above example) is doing is passing those values as JSON in the POST request body.

requests.get() is going to return a requests.Response object, so it's also a bit nonsensical to assign it to a variable called requestObject .

Review the following docs:

• Post Requests
• Passing parameters in URLS
• Custom Headers
• Timeouts
• Errors and Exceptions

It's not a functional problem in your code, but by convention , function and variable names should be lowercase in Python and use underscores to separate terms, not camel case. Eg response_object rather than responseObject, api_key rather than API_KEY, and client_id rather than client_ID. Again, it doesn't make your code not work, it's just convention. You can ignore it, but I wanted to point it out at least.

Answer 2

To fix your immediate error, the url you are passing into the requests function is not complete. The message you get shows that the url starts with /v2 , while it needs to have the complete url, that is, starting https:// .

For your header question, the headers is a simple dictionary of key/value pairs, along the lines of:

headers = {"x-api-key": "myapiKEY123", }

From there, you are passing it into the requests.get function correctly.