Skip to content

Getting Started

To start using Wogeez, begin by creating a user account. Once registered, you’ll receive your API credentials, allowing you to authenticate and access the API endpoints. Follow the Setup guide for instructions on configuring your account, connecting devices, and initiating your first API calls.

This documentation will guide you through every step, from account setup to advanced API configurations. Use the navigation bar on the left to explore sections on installation, device integration, resource management, API calls, and troubleshooting.

Explore, automate, and manage your resources with Wogeez — simplifying control, enhancing connectivity, and offering powerful management capabilities through a single API.

Authentication and API Calls

This sequence diagram illustrates the process of authenticating a user and subsequently making API calls to the Wogeez services. The workflow is broken down into key steps to provide a clear understanding of how the authentication mechanism works in conjunction with the API interactions.

Sequence diagram

sequenceDiagram
  autonumber
  User->>AuthService: Request JWT Token (username, password)
  AuthService-->>User: Return JWT Token

  User->>Wogeez API: Call GET /companies (Authorization: Bearer JWT Token)
  Wogeez API-->>User: Return list of companies

  User->>Wogeez API: Call GET /specific-endpoint (Authorization: Bearer JWT Token)
  Wogeez API-->>User: Return specific data

Steps in the Sequence Diagram

  1. User Requests JWT Token:

    • The process begins with the User sending a request to the AuthService to obtain a JSON Web Token (JWT). This request includes the user's credentials, specifically the username and password.
    • This step is crucial for establishing the identity of the user and ensuring secure access to the Wogeez system.

  2. AuthService Responds with JWT Token:

    • Upon successfully validating the user's credentials, the AuthService responds by returning a JWT token.
    • This token serves as a proof of authentication and is required for any subsequent API requests.

  3. User Calls Wogeez API:

    • With the JWT token in hand, the User can now make authorized requests to the Wogeez API. The first API call shown in the diagram is to the GET /companies endpoint.
    • This call retrieves a list of companies associated with the user's account, allowing the user to manage and interact with their organizational data.

  4. Wogeez API Responds with Company Data:

    • The Wogeez API processes the request and returns a response containing the list of companies in JSON format.
    • This response enables the user to view and work with their company information.

  5. User Makes Additional API Calls:

    • The user may then make further requests to additional endpoints within the Wogeez API, as depicted in the diagram with a call to GET /specific-endpoint.
    • Each request continues to utilize the JWT token for authorization, ensuring that the user remains authenticated while accessing various resources and functionalities.