Zippyy REST APIs
  1. Authentication API
Zippyy REST APIs
  • Introduction
  • Authentication API
    • Generate Token
      POST
  • Couriers
    • Check Courier Serviceability
      GET
    • Quick Quote
      POST
    • Forward Shipment (V2)
      POST
    • Forward Shipment
      POST
  • Shipments
    • Get Details of Specific Shipment
      GET
    • Generate Label
      GET
    • Generate Label Url
      GET
    • Cancel a Shipment
      PUT
    • Generate Invoice
      GET
  • Tracking
    • Get Tracking Details
      GET
    • Webhook
      POST
  • NDR
    • Action NDR
      PUT
  • Warehouse
    • Get Warehouse
      GET
    • List of Warehouse details
      GET
    • Create new Warehouse
      POST
    • Update existing warehouse properties
      PUT
  1. Authentication API

Generate Token

POST
/v1/external/auth/login

User Authentication Endpoint#

This endpoint is designed for user authentication within the Zippyy application. It allows users to log in by providing their email address and password.

Request#

Method: POST
URL: https://{{base_url}}/v1/external/auth/login

Request Body#

The request body must be sent in JSON format and should contain the following parameters:
emailAddress (string): The email address of the user attempting to authenticate.
password (string): The password associated with the user's account.
Example Request Body:
{
  "emailAddress": "user@example.com",
  "password": "your_password_here"
}

Response#

The response from the server will be in JSON format.

Response Structure#

idToken (string): A token that identifies the user.
accessToken (string): A token used for accessing protected resources.
refreshToken (string): A token used to obtain a new access token.

Error Handling#

A status code of 500 indicates a server error, which may occur due to various reasons such as incorrect credentials or server issues. It is important to handle this response appropriately in your application.
Ensure that the request body is correctly formatted and all required fields are included to avoid errors during authentication.
This endpoint is designed for user authentication within the Zippyy application. It allows users to log in by providing their email address and password.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200200 OK - Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/external/auth/login' \
--header 'x-api-version: 1' \
--header 'Content-Type: application/json' \
--data-raw '{
  "emailAddress": "abc@zippyy.ai",
  "password": "123123"
}'
Response Response Example
{
    "idToken": "eyJraWQiOiJYclBpQ1wvbm1SbDdpb0pxajJX..",
    "accessToken": "eyJraWQiOiJiK1JkMHVTQVdcLzF4amhH..",
    "refreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU.."
}
Modified at 2025-08-04 19:55:15
Previous
Authentication API
Next
Couriers
Built with