API Reference

Backend API to be called for initializing the automatic authentication process. To ensure security, this API must be called from the SIS backend and the API credentials must be stored securely.

Endpoint

POST /api/external/token

Request Headers

Name	Value
Content-Type	application/json
Authorization	Basic <base64Encoded(<clientId>:<clientSecret>)>

Example

Content-Type: application/json
Authorization: Basic VGhpc0lzVGhlU2Nob29sc0NsaWVudElEOlRoaXNJc0FTZWNyZXRLZXk=

Authorization Parameters

Use Basic Authorization method and base encode the following parameters in the above format.

Name	Description
clientId	Client ID for the school created by zenda.
clientSecret	Client Secret Key for the school created by zenda.

Request Body

{
        "targetMetadata": {
            "useCase": "AU",
            "targetData": {
                "path": "DB" //Dashboard
            }
        },
        "studentDetails": {
            "registerNo": "12345",
        },
        "parentDetails": {
            "email": "[email protected]",
            "phone": "[phone]"
        },
 }

Request Parameters

• targetMetadata - Object

Name	Type	Mandatory	Description
useCase	String	Mandatory	Targeted use case of the flow. Pass “AU” for authentication.
targetData	Object	Mandatory	Targeted landing page details which the zenda app will open on redirection. Use "DB" as the Target Path.

• studentDetails - Object

Name	Type	Mandatory	Description
registerNo	String	Mandatory	Registration number or Student ID of the Student. A valid Registration Number or Student ID needs to be passed.

Note: The registration Number or Student ID can be of any student in the family. It not necessarily the student whose invoices need to be paid. Once the parent comes to zenda, they will be able to pay for any or all students.

• parentDetails - Object

Name	Type	Mandatory	Description
email	String	Pass only if email was used to login	Parent E-Mail ID. (Max 320 character) If both are passed, only email will be considered.
phone	String	Pass only if phone was used to login	Parent’s mobile number with country code. (Max 15 digits)

Response Body

200

{
        "referenceToken": "WmVuZGEsIGEgZmludGVjaCBhcHAgZm9yIGZhbWlsaWVzLiBWaXNpdCB1cyBhdDogaHR0cHM6Ly93d3cuemVuZGEuY29tLw==",
        "expiresAt": "2024-09-30T13:03:14.705871Z"
}

400

401

Response Parameters

Name	Type	Description
referenceToken	String	Reference token for the transaction.
expiresAt	String	Expiry timestamp of the token.