Quickstart

Use this guide to configure API credentials and make your first request.

Get your API key

Log in to your Algure account
Head over to Settings > Organization > Intergations
Click on Algure API > Create configuration
Give your integration a name
Copy the Username and Password and store it securely

Your first request

Use the following command to list all the countings in your organization. Replace USERNAME and PASSWORD for the credentials you copied earlier.

curl --request GET \
  --url https://api.algure.com/v1/countings \
  --user USERNAME:PASSWORD \
  --header 'Content-Type: application/json' 

The response

If everything was set up correctly, you should see a list with the countings of your organization:

{
  "items": [
    {
      "id": "00bb39e1-0d92-4c2b-ab2b-eb96950ec221",
      "warehouse": {
        "id": 10,
        "code": "LOG",
        "name": "LOGÍSTIC",
        "slug": "log"
      },
      "active": false,
      "startedAt": "2024-11-06T08:47:37.025Z",
      "endsAt": "2024-11-06T12:47:00.000Z",
      "participants": [
        {
          "id": 40,
          "username": "Pere"
        }
      ],
      "totalProducts": 211,
      "totalProductsCounted": 211,
      "totalProductsLeft": 0,
      "totalDiscrepancies": 5,
      "totalIncidents": 1
    }
  ],
  "meta": {
    "total": 1
  }
}

API Reference

Core API