API Keys

We use API keys to authenticate requests. You can view and manage your API keys through the vivenu Dashboard or via the API.

Endpoints

The API Key Object

Attributes

_id

Required

string

The ID of the API key.

name

Required

string

An internal name to identify the API key.

key

Required

string

The secret key to be used to authenticate against the API.

createdAt

Required

string date-time

An ISO Timestamp indicating when the API Key was created.

updatedAt

Required

string date-time

An ISO Timestamp indicating when the API Key was last updated.

Optional Attributes

Collapse all

active

Optional

boolean

Whether the API key can be used to authenticate against the API.

sellerId

Optional

string

The ID of the seller that owns the API key.

orgId

Optional

string

The ID of the organisation that owns the API key.

createdBy

Optional

object

The entity that created the API key.

createdBy.type

Required

string

The type of the entity

USERAPPAPI_KEY

createdBy.id

Required

string

The ID of the entity

Was this section helpful?

Yes No

{
  "_id": "string",
  "active": true,
  "name": "string",
  "sellerId": "string",
  "orgId": "string",
  "key": "key_somerandomcombinationofnumbersandletters",
  "createdBy": {
    "type": "USER",
    "id": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create an API Key

Payload

name

Required

string

An internal name to identify the API key.

Optional Attributes

Collapse all

orgId

Optional

string

The organization ID for which to create the API key.

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Was this section helpful?

Yes No

{
  "name": "string",
  "orgId": "string"
}

{
  "_id": "string",
  "active": true,
  "name": "string",
  "sellerId": "string",
  "orgId": "string",
  "key": "key_somerandomcombinationofnumbersandletters",
  "createdBy": {
    "type": "USER",
    "id": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get an API Key

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "active": true,
  "name": "string",
  "sellerId": "string",
  "orgId": "string",
  "key": "key_somerandomcombinationofnumbersandletters",
  "createdBy": {
    "type": "USER",
    "id": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update an API Key

Payload

Optional Attributes

Collapse all

active

Optional

boolean

Whether the API key can be used to authenticate against the API.

name

Optional

string

An internal name to identify the API key.

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "active": true,
  "name": "string"
}

{
  "_id": "string",
  "active": true,
  "name": "string",
  "sellerId": "string",
  "orgId": "string",
  "key": "key_somerandomcombinationofnumbersandletters",
  "createdBy": {
    "type": "USER",
    "id": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get All API Keys

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "active": true,
    "name": "string",
    "sellerId": "string",
    "orgId": "string",
    "key": "key_somerandomcombinationofnumbersandletters",
    "createdBy": {
      "type": "USER",
      "id": "string"
    },
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

ORG

Get or Create a Default API Key

Payload

sellerId

Required

string

The seller ID to get or create the API key for.

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "sellerId": "string"
}

{
  "_id": "string",
  "active": true,
  "name": "string",
  "sellerId": "string",
  "orgId": "string",
  "key": "key_somerandomcombinationofnumbersandletters",
  "createdBy": {
    "type": "USER",
    "id": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get Information about the used API Key

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "active": true,
  "name": "string",
  "sellerId": "string",
  "orgId": "string",
  "key": "key_somerandomcombinationofnumbersandletters",
  "createdBy": {
    "type": "USER",
    "id": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}