Skip to content

Getting Started#

Vayana GSP’s API service over GSTN peers.

GSTN Peers

  • GST Returns Portal
  • E-Way Bills Portal
  • E-Invoicing Portal

Some terms we will be using in the documentation further,

  • Flynn - Enriched API Service (EAS)
  • Theodore - (Vayana’s SSO) Authentication Service
  • Org - Entity to whom Vayana will bill to
  • User - Caller / Consumer of the service, must belong to the Org and must have primary relationship with the Org

Modules#

Basic APIs#

All apis under this bucket are a simple wrapper over the base services. Most of the cases you find the url pattern matching with GST documentation. Only the encryption and decryption of the payload and auth-token management is abstracted in this module.

The ‘input’ and ‘output’ of APIs in basic module will be quite similar (mostly wrapped under a key, along with some other parameters) to the GST official documents.

Example

  • Search Taxpayer

  • Request OTP

  • Get Summary (GSTR1)

Enriched APIs#

All apis under this bucket are wrapper on top of the basic APIs as described here. Downloadable file in response, multipart responses or Validation of data before actual API call; these are some examples of the additional functionality on top of the basic API offered under GST stack.

Example

  • Search Taxpayer Details with Return Filing Status in Bulk

  • E-Invoicing APIs w/ session mgmt.

    • bulk create e-invoice
    • generate downloadable/shareable pdf of the invoice
    • send email to counter-party on creation of e-invoice

  • Get all applicable ‘GST returns data’ for a “time range”

Environments#

Active Version

Enriched API Service: v1.0, v2.0, v3.0

Production#

This environment uses live GSTN infra; all API calls will be chargeable

Base URL: https://live.enriched-api.vayana.com

Sandbox#

This environment is to test your application using sandbox GSTN - no API charges

Base URL: https://solo.enriched-api.vayana.com

Server’s Public Key#

Make Sure you have downloaded EAS server’s Public Key for the specific environment. The .pem file (public key) will be used further calling the APIs with sensitive data. Client will have to encrypt REK (Request Encryption Key) using this public key. Download the required public-key here.