Welcome to the GOA API

Welcome to the official documentation of the GOA API. Below you can find some important information about how to interact with our API.

API Information

Our API is designed to offer a powerful and easy-to-use interface for interacting with the system.

API Version

v1.0

Authentication

To authenticate and interact with the API, you will need to obtain an API token. Use the following endpoints:

  • Login: /api/v1/auth/token (POST)
  • Logout: /api/v1/auth/token (POST)

Protected Endpoints

The following endpoints are protected and require authentication via a valid token:

  • Get projects: /api/v1/projects (GET) - Access your projects list
  • Get items: /api/v1/items (GET) - Access your items list ( projectId is mandatory )
  • Get suppliers: /api/v1/suppliers (GET) - Access your suppliers list ( projectId is mandatory )
  • Get teams: /api/v1/teams (GET) - Access your teams list ( projectId is mandatory )

API Response Format

All responses are returned in JSON format.

Example Response

{
    "data": {
        "param_1": 1,
        "param_2": "Jose Gomes",
        "param_3": "josegomes@codefive.pt"
    }
}

Rate Limiting

Our API is rate-limited to prevent abuse. Ensure that your requests are within the allowed rate limits to avoid service interruptions.

Contact

If you need support or have any questions, feel free to reach out to us at josegomes@codefive.pt.