---
updatedAt: 2026-06-23T08:14:20.000Z
agentTools:
  projectIndex: https://dev-scp.splio.com/llms.txt
---

# Authentication

Get a valid JSON Web Token. This token, prefixed by 'Bearer ', can be used to call other endpoints for 24 hours.

# Error cases

## 400 authentication failed (wrong credentials)

```json
{
    "status": 400,
    "errors": [
        {
            "error_key": "username",
            "error": "authentication.failed",
            "error_description": "User authentication failed."
        }
    ]
}
```

## 400 missing api\_key field

```json
{
    "status": 400,
    "errors": [
        {
            "error_key": "api_key",
            "error": "is_blank",
            "error_description": "Api key is missing."
        }
    ]
}
```

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-origin": [
    {
      "url": "https://api.splio.com/doc.json",
      "format": "swagger",
      "version": "2.0",
      "converter": {
        "url": "https://github.com/mermade/oas-kit",
        "version": "7.0.8"
      }
    }
  ],
  "info": {
    "title": "Splio Customer Platform",
    "description": "API Documentation for Splio Customer Platform",
    "version": "1.0.0"
  },
  "paths": {
    "/authenticate": {
      "post": {
        "summary": "Authentication",
        "description": "Get a valid JSON Web Token. This token, prefixed by 'Bearer ', can be used to call other endpoints for 24 hours.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "api_key",
                  "password"
                ],
                "properties": {
                  "api_key": {
                    "description": "Api key available in the api users list of your universe. Please refer to your universe's administrator to retrieve an api key.",
                    "example": "XXXXYYYYZZZZ",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "description": "Use an api key to get a JWT token valid for 24 hours. Universe's api keys are manageable in the admin section, refer to your universe's administrator to get one.",
          "required": true
        },
        "responses": {
          "200": {
            "description": "Api key is recognized, user is successfully authenticated. This token, prefixed by 'Bearer ', can be used to call other endpoints for 24 hours.",
            "content": {
              "application/json": {
                "examples": {
                  "response": {
                    "value": {
                      "token": "XXXXXXXXYYYYYYYYYYZZZZZZZZZZZZ"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Authentication failed."
          }
        },
        "tags": [
          "General"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.splio.com"
    },
    {
      "url": "http://api.splio.com"
    }
  ]
}
```