Title: Generate a Customer Authentication Token Using the API
PrimaryCategory: API
Type: Procedural
Tags: authentication, token, API, customer, security, ip_verification
Source UI Terms: auth-userid, api-key, username, passwd, ip, GET
Source Reference: Generate a Customer Authentication Token Using the API

Prerequisites:
- You must have valid API credentials (auth-userid and api-key).
- Know the customer&#39;s username and password.
- Know the IP address of the customer making the request.

Steps:
1) Send a GET request to the API endpoint:
   `https://test.httpapi.com/api/customers/generate-token.json`
2) Include the following parameters in the query string:
   - `auth-userid`: Your API user ID (integer).
   - `api-key`: Your API key (string).
   - `username`: The customer&#39;s username (string).
   - `passwd`: The customer&#39;s password (string).
   - `ip`: The customer&#39;s IP address (string).
3) The API will authenticate the customer credentials and verify the IP address.
4) If successful, the API returns a string token that is valid for 120 seconds.
5) If authentication fails or an error occurs, the response includes a `status` key with value `ERROR` and an error message.

Warnings:
- Note: The authentication token is valid only for 120 seconds, so use it promptly.

Summary:
You can authenticate a customer and generate a temporary authentication token by sending a GET request to the API with required credentials and the customer&#39;s IP address. The token returned is valid for two minutes only.

Evaluation Pairs:
Q: What parameters are required to generate a customer authentication token using the API?  
A: You must provide auth-userid, api-key, username, passwd, and ip as required parameters.

Q: How long is the authentication token valid once generated?  
A: The token is valid for only 120 seconds (2 minutes).

Q: What happens if customer credentials are incorrect or an error occurs?  
A: The API returns a response with a status key set to ERROR along with an error message.

<p>When you want to authenticate a customer and generate a temporary authentication token using the API. This article explains the required authentication parameters, customer credential validation, IP verification, token generation process, and token validity limitations.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Generating a Token</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Authenticates a Customer by returning an authentication token on successful authentication.</p>
<div class="note"><strong>Note</strong>
<p>The token will be valid for a duration of only 120 seconds.</p>
</div>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">username</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Username of the Customer</td></tr><tr><td colspan="1" rowspan="1">passwd</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Password of the Customer</td></tr><tr><td colspan="1" rowspan="1">ip</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">IP address of the Customer</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/customers/generate-token.json?auth-userid=0&amp;api-key=key&amp;username=username@customer.com&amp;passwd=customerpassword&amp;ip=1.1.1.1 </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns a token (String) if the Customer is authenticated successfully.</p>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> alongwith an error message will be returned.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to authenticate a customer and generate a temporary authentication token using the API. This article explains the required authentication parameters, customer credential validation, IP verification, token generation process, and token validity limitations.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
username	String	Required	Username of the Customer
passwd	String	Required	Password of the Customer
ip	String	Required	IP address of the Customer