Authentication
GEP REST API & Bulk API secure HTTP endpoints are accessible using JWT. Clients need to generate JWT token as mentioned below and send it along with the request in the header as a Bearer token.
1. A unique identifier will be generated for each customer.
2. Each customer will be provided with the unique identifier. Customer will have to send client certificate along-with unique identifier as part of request to generate JWT.
3. Each customer will be given separate Token Service URL to create JWT.
4. Each Token Service URL will have an associated policy.
5. Customer certificate can also be used instead of GEP certificate for authentication. Additionally, IP address restriction can also be supported.
Request
Attribute |
Description |
Client Certificate |
Certificate to authenticate the request |
gep-auth-key |
Unique key which will be used for token generation |
Sample Request:
GET /token/gep HTTP/1.1
Host: api-smart.gep.com
Client Certificate: {...}
gep-auth-key: customer-unique-identifier
Response:
Attribute |
Description |
Expires |
Expiry time in minutes |
Token |
JWT Token |
StatusCode |
Status code for the response |
ErrorMessage |
Reason for the error, if any. |
Sample Response:
{
"Expires": 120,
"Token": "your-jwt-token",
"StatusCode": 200,
"ErrorMessage": ""
}
Status Code |
Description |
200 |
OK |
403 |
Forbidden |
500 |
Internal Server Error |