THE HEADERS REQUEST

The partnerKey parameter

To make the consumption of our API it is necessary that you use the partnerKey that was assigned when you activate your user, this token is used to authenticate you because this field contain the identifier assigned to your user on The HoundExpress and is validated on each request that you send to our system.

🚧

If this parameter does not exist in the header, is possible you will receive the following error code when you try to consume the services:

1. NOPKEY
2. To consume this service is necessary to use a signed user or append the partnerKey
3. No partnerKey Found!

Therefore for all the consumption of the API that you make within The HoundExpress API, it is necessary that this parameter be sent as part of the request header.

At the moment of the implementation in a productive environment this pernterKey does not change because the user is only promoted to the production environment through a role change in our system.

This mechanism is designed so that when you finish your development you don't have to change practically anything. Since both the endpoint and the credentials to authenticate in our system remain the same.

The environment parameter (optional)

If your user still has a developer role, our server will automatically direct you to the QA environment. After completing the implementation of our web services in their development, the user is directed to the production environment by changing the role. However, in case your user already has the privileges to be used in the productive environment and you need to connect to the test environment again, you can do it by sending the header: "environment" with the value: "QA"
If your user still has a developer role, you don't need to send this header
If you send any other value for the header this has no effect.

Whenever you are logged into the site of The HoundExpress API you can also find a link to this page in the top nav bar.

Below we show you an example of the headers where the partnerKey token is included.

Header Example

As you can see one of the headers key-value pair is the partnerKey and another is the .

📘

HeaderKey	Value
partnerKey	your partner key
Evironment	QA