Skip to content

ERM GraphQL API Overview

Table of Contents

Overview

The Omnivoltaic API and GraphQL environment provide a comprehensive interface for interacting with various aspects of our company's Enterprise Resource Management (ERM) system. This documentation outlines the functionalities, usage, and key aspects of this tool.

Accessing the API

URL Endpoint

  • URL: Omnivoltaic GraphQL API
  • Purpose: The primary access point for querying and mutating data related to our ERM System.

Key Functionalities

1. Login API

  • Purpose: To authenticate users and generate an access token for API calls.
  • Usage: Distributor credentials are used to generate an access token.
  • Mutation example:
mutation {
  signInClient(signInCredentialsInput: {
    email: ""
    password: ""
  }) {
    accessToken
  }
}

Authorization

The generated access token must be included in the HTTP Headers for all subsequent API calls as Authorization: Bearer accessToken

2. Generated Codes

  • Generated Days Code: Creates a day-specific code for an item
  • Generate Free Code: Generates a free code for an item
  • Generated Reset Code: Produces a reset code for an item
  • Usage: These mutations are used to generate various types of codes, each serving different purposes, such as temporary access, complimentary access, or resetting the item's state.

3. Code History Query

  • Purpose: Retrieves the history of all code events for a specific item by the distributor.
  • Usage: Useful for tracking the code issuance and usage history for items.

4. Item Fleet Query

  • Purpose: Fetches item fleet information for a specific client
  • Usage: Helps in managing and understanding the distribution and assignment of item fleets to clients.

5. Client Items Query

  • Purpose: To query all items associated with a client
  • Usage: Provides a comprehensive view of all clients, aiding in client assets, including credits and account stages.

6. Assets Account Query

  • Purpose: Retrieves information for a specific client.
  • Usage: Essential for managing and understanding the financial aspects of client assets, including credits and account stages.

How ERM Works in the Company

  • Centralised Management: The ERM System centralizes the management of assets, clients, transactions and codes providing a unified platform for handling these elements.
  • Data Accessibility: Through the GraphQL API, various aspects of the ERM system are easily accessible and modifiable allowing for real-time data retrieval and updates.
  • Flexibility: The system's flexibility is highlighted by its ability to handle various types of queries and mutations, adapting to different business needs and scenarios.

Through this system, we achieve streamlined operations, enhanced data accessibility and effective resource management, all crucial for our company's efficiency and growth.