404 error during attempted export of KB articles | Community
Skip to main content

404 error during attempted export of KB articles

  • September 20, 2023
  • 5 replies
  • 0 views
Mark33

Hi. I'm trying to export our KB articles using this ZD documentation: https://developer.zendesk.com/documentation/help_center/help-center-api/backing-up-your-knowledge-base-with-the-help-center-api/

Because we use SSO and 2FA to log into ZD, I changed the authentication method in the script from credentials to API key. I believe I formatted the script correctly, but I'm getting an unexplained 404. Any thoughts about what might be going wrong? 

Here's my modified version of the Python script provided in the documentation: 

import os

import datetime




import requests




api_token = 'MY_ZENDESK_TOKEN'

zendesk = 'https://securityscorecard.zendesk.com'

language = 'en_US'




date = datetime.date.today()

backup_path = os.path.join(str(date), language)

if not os.path.exists(backup_path):

    os.makedirs(backup_path)




headers = {

    'Authorization': f'Bearer {api_token}',

}




endpoint = zendesk + '/api/v2/help_center/en-US/articles.json'.format(locale=language.lower())

response = requests.get(endpoint, headers=headers)

if response.status_code != 200:

    print('Failed to retrieve articles with error {}'.format(response.status_code))

    exit()

data = response.json()




for article in data['articles']:

    print(article['id'])

    5 replies

    Nathan16
    • Nathan16
    • September 20, 2023

    The locale needs to be in lowercase. In this line:

    endpoint = zendesk + '/api/v2/help_center/en-US/articles.json'.format(locale=language.lower())

    You hardcoded the "en-US" which should be replaced with "{locale}". Also make sure to set the language variable to "en-US" instead "en_US" (with underscore).

    Hope this helps!

    C
    • Charles32
    • September 20, 2023

    Also, an API token in Zendesk is different than an OAuth token. So the following header won't work:

    headers = {
        'Authorization': f'Bearer {api_token}',
    }

    An API token should be used as follows in a Python request (see API token in the docs for details):

    api_token = 'MY_ZENDESK_TOKEN'
    your_email_address = 'myself@example.com'
    credentials = f'{your_email_address}/token', f'{api_token}'

    In the API request, add the `credentials` variable to the `auth` parameter:

    response = requests.get(endpoint, auth=credentials)

     

     

    Mark33
    • Mark33
    • Author
    • September 20, 2023

    Thank you for the suggestions @nathan16 and @charles32!

    So, now I'm no longer getting a 404. Now I'm getting different output after running the script:

    First, there's a list of 30 article IDs from our KB.

    Then there's a message: 

    Failed to retrieve articles with error 200: (which is weird because 200 is typically a "success" message)

    ...which is followed by a massive blob of text. I analyzed the text and it includes all the IDs in that list of 30.

    Then, for each article ID, it shows some words from the article and some metadata. 

    And the backup folder that gets created by the script is empty.

    Has anyone experienced this?


    Mark33
    • Mark33
    • Author
    • September 20, 2023

    Also, @charles32, regarding your comment about using an OAuth header ^^ should I replace that header or just get rid of it?

    Your comment for reference: 

    Also, an API token in Zendesk is different than an OAuth token. So the following header won't work:

    headers = {
        'Authorization': f'Bearer {api_token}',
    }
    C
    • Charles32
    • September 21, 2023

    Yes, you should delete the header.

    Terms & ConditionsCookie settingsAccessibility statement