Skip to content

API Interaction

Wogeez Engine

The example provided above demonstrates the first API call you will make to the Wogeez system using the GET /companies endpoint. This initial call is crucial for retrieving information about your company and any associated companies, setting the stage for further interactions with the API.

How to use

  1. Authentication: Ensure you are authenticated before making a request to this endpoint. You must include a valid JWT token in the Authorization header.
  2. Making a Request: Send a GET request to the /companies endpoint and include the JWT token in the request header.
Retrieve your company and associated companies
curl -X GET "https://api-v2.wogeez.com/companies" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Accept: application/json"

The response includes mine, which contains the user’s company, and memberOf, an array listing each company of the user.

Response provides details about the user and the companies
{
  "response": {
    "mine": {
      "id": "d013e5cb-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Corentin"
    },
    "memberOf": [
      {
        "id": "afee93e6-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "name": "afee93e6-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      }
    ]
  }
}

Accessing the API Documentation

For a comprehensive list of all available endpoints, including their descriptions, request methods, and parameters, you can refer to the Swagger API documentation.

Key Features of Swagger Documentation

  • Interactive Interface: Swagger provides an easy-to-use interface that allows you to explore the available API endpoints directly from your web browser.
  • Detailed Descriptions: Each endpoint is documented with information on how to use it, including required headers, request body formats, and possible responses.
  • Try-It-Out Functionality: You can test API calls directly from the Swagger UI by entering parameters and executing requests without the need for additional tools like curl.

By utilizing the provided GET /companies example and exploring the Swagger documentation, you will gain a solid understanding of how to interact with the Wogeez API. This will empower you to manage your company information and leverage the full capabilities of the system efficiently.

This interactive documentation is accessible at the following URL

API Reference