List API Keys

• Introduction
• Authentication
  • postRetrieve a token
• Organizations
  • getList Organizations
  • postCreate an Organization
  • getRetrieve an Organization
  • putUpdate an Organization
  • delDelete an Organization
• Users
  • getList Users
  • postInvite a User
  • getRetrieve a User
• API Keys
  • getList API Keys
  • postCreate API Key
  • putUpdate API Key Status
  • getRetrieve API Key
  • delDelete API Key

API docs by Redocly

fiskaly Management API (v0.1.0-draft)

Download OpenAPI specification:

fiskaly GmbH: info@fiskaly.com URL: https://fiskaly.com

Imprint: fiskaly.com/impressum | Privacy Policy: fiskaly.com/datenschutz

Introduction

The fiskaly Management API is a RESTful API that can be used for automatizing concerns within the fiskaly dashboard.

Authentication

Our API uses JWT tokens to authenticate requests. API requests without authentication will fail. All API requests have to be made over HTTPS, while requests made over plain HTTP will fail.

JWT

A JSON Web Token (JWT) used for access control and authorization.

API keys have to be obtained via the fiskaly dashboard.

• Usage format: Bearer <JWT>
• Example HTTP header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Security Scheme Type: HTTP

HTTP Authorization Scheme: bearer

Bearer format: JWT

Retrieve a token

Access to our API is only granted with a valid JWT / authorization token that must be obtained using this endpoint.

Note: If you don't have an api_key yet, you can request an API key.

Request Body schema: application/json

One of

objectobject

api_key required	string
api_secret required	string

Responses

200

Successful authentication

post/auth

/api/v0/auth

Request samples

• Payload

Content type

application/json

Copy

{

• "refresh_token": "string",
• "api_key": "...",
• "api_secret": "..."

}

Response samples

• 200

Content type

application/json

Copy

{

• "access_token": "string",
• "access_token_expires_in": 300,
• "access_token_expires_at": 1577833200,
• "refresh_token": "string",
• "refresh_token_expires_in": 300,
• "refresh_token_expires_at": 1577833200

}

Organizations

Endpoints for managing Organizations.

List Organizations

foo

Request Body schema: application/json

object

Responses

200

Default Response

get/organizations

/api/v0/organizations

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Create an Organization

foo

Request Body schema: application/json

object

Responses

200

Default Response

post/organizations

/api/v0/organizations

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Retrieve an Organization

foo

Request Body schema: application/json

object

Responses

200

Default Response

get/organizations/{organization_id}

/api/v0/organizations/{organization_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Update an Organization

foo

Request Body schema: application/json

object

Responses

200

Default Response

put/organizations/{organization_id}

/api/v0/organizations/{organization_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Delete an Organization

foo

Request Body schema: application/json

object

Responses

200

Default Response

delete/organizations/{organization_id}

/api/v0/organizations/{organization_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Users

Endpoints for managing User Accounts / Logins.

List Users

foo

Request Body schema: application/json

object

Responses

200

Default Response

get/organizations/{organization_id}/users

/api/v0/organizations/{organization_id}/users

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Invite a User

foo

Request Body schema: application/json

object

Responses

200

Default Response

post/organizations/{organization_id}/users/{email}

/api/v0/organizations/{organization_id}/users/{email}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

Retrieve a User

foo

Request Body schema: application/json

object

Responses

200

Default Response

get/organizations/{organization_id}/users/{user_id}

/api/v0/organizations/{organization_id}/users/{user_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

{ }

API Keys

Endpoints for managing API Keys.

List API Keys

List API Keys

query Parameters

order_by	string Enum: "name" "kind" "status" Specifies the property to sort by
order	string Default: "asc" Enum: "asc" "desc" Determines the sorting order
limit	integer <= 100 Default: 100 Limits the number of returned results
offset	integer Default: 0 Skips the specified number of results from the result set
kind	Array of strings[ items unique ] Items Enum: "test" "live" Filter to include only a specific kind
status	Array of strings[ items unique ] Items Enum: "enabled" "disabled" Filter to include only a specific status

Responses

200

Returns the API Key list

403

Forbidden. Resource access denied.

get/organizations/{organization_id}/api-keys

/api/v0/organizations/{organization_id}/api-keys

Response samples

• 200
• 403

Content type

application/json

Copy

Expand all Collapse all

{

• "data": [

  • {

    • "name": "string",
    • "kind": "test",
    • "status": "enabled",
    • "metadata": {

      • "my_property_1": "1234",
      • "my_property_2": "https://my-internal-system/path/to/resource/1234"

      },
    • "_id": "string",
    • "_name": "string",
    • "_type": "API_KEY"

    }

  ],
• "count": 9007199254740991,
• "_type": "API_KEY_LIST"

}

Create API Key

Create an API Key

path Parameters

key_name required

string^[a-z0-9-]{3,30}$ Name of the API Key

Request Body schema: application/json

kind required	string Enum: "test" "live"
status required	string Enum: "enabled" "disabled"
metadata	object <= 20 properties You can use this parameter to attach custom key-value data to an object. Metadata is useful for storing additional, structured information on an object. Note: You can specify up to 20 keys, with key names up to 40 characters long and values up to 500 characters long.

Responses

200

Default Response

400

Bad Request. An API Key with this name already exists.

403

Forbidden. Resource access denied.

post/organizations/{organization_id}/api-keys/{key_name}

/api/v0/organizations/{organization_id}/api-keys/{key_name}

Request samples

• Payload

Content type

application/json

Copy

Expand all Collapse all

{

• "kind": "test",
• "status": "enabled",
• "metadata": {

  • "my_property_1": "1234",
  • "my_property_2": "https://my-internal-system/path/to/resource/1234"

  }

}

Response samples

• 200
• 400
• 403

Content type

application/json

Copy

Expand all Collapse all

{

• "name": "string",
• "kind": "test",
• "status": "enabled",
• "metadata": {

  • "my_property_1": "1234",
  • "my_property_2": "https://my-internal-system/path/to/resource/1234"

  },
• "_id": "string",
• "_name": "string",
• "_type": "API_KEY",
• "secret": "string"

}

Update API Key Status

Update an API Key Status

path Parameters

key_name required

string^[a-z0-9-]{3,30}$ Name of the API Key

Request Body schema: application/json

status

string Enum: "enabled" "disabled"

Responses

200

Default Response

403

Forbidden. Resource access denied.

put/organizations/{organization_id}/api-keys/{key_name}

/api/v0/organizations/{organization_id}/api-keys/{key_name}

Request samples

• Payload

Content type

application/json

Copy

{

• "status": "enabled"

}

Response samples

• 200
• 403

Content type

application/json

Copy

Expand all Collapse all

{

• "name": "string",
• "kind": "test",
• "status": "enabled",
• "metadata": {

  • "my_property_1": "1234",
  • "my_property_2": "https://my-internal-system/path/to/resource/1234"

  },
• "_id": "string",
• "_name": "string",
• "_type": "API_KEY"

}

Retrieve API Key

Retrieve an existing API Key

path Parameters

key_name required

string^[a-z0-9-]{3,30}$ Name of the API Key

Responses

200

Default Response

403

Forbidden. Resource access denied.

get/organizations/{organization_id}/api-keys/{key_name}

/api/v0/organizations/{organization_id}/api-keys/{key_name}

Response samples

• 200
• 403

Content type

application/json

Copy

Expand all Collapse all

{

• "name": "string",
• "kind": "test",
• "status": "enabled",
• "metadata": {

  • "my_property_1": "1234",
  • "my_property_2": "https://my-internal-system/path/to/resource/1234"

  },
• "_id": "string",
• "_name": "string",
• "_type": "API_KEY"

}

Delete API Key

Delete an existing API Key

path Parameters

key_name required

string^[a-z0-9-]{3,30}$ Name of the API Key

Responses

200

Default Response

403

Forbidden. Resource access denied.

delete/organizations/{organization_id}/api-keys/{key_name}

/api/v0/organizations/{organization_id}/api-keys/{key_name}

Response samples

• 200
• 403

Content type

application/json

Copy

{

• "deleted": true

}