Authentication Overview

Introduction

AppZen’s external APIs support API key-based authentication (OAuth1.0).

OAuth ("Open Authorization") provides clients a "secure delegated access" to server resources. It uses the customer_id and API key combination to allow access to the public APIs.

Authentication for these APIs is done based on the following fields provided by the AppZen Support team:

  1. customer_id: You will be provided with a unique value for this field.
  2. x-api-key: You will be provided with a unique value for this field. 
  3. customer-key: You will be provided with a unique value for this field.

Testing API Keys

Once you receive the keys you can run the following curl command to test the API.

"curl --location --request GET 
'https://api.appzen.com/dictionary-data-services/generate-upload-url' \
--header 'customer-id: {{customer id}}' \
--header 'customer-key: {{customer key}}' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json'

If all the fields are correct, then you will receive a response with Status Code 200 OK. 

See Also

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.