Link Search Menu Expand Document

API Keys

API keys offer an alternate method of authentication to the Matatika API using a client ID and secret. Access using API key credentials is supported by the Matatika CLI and SDK, which allows a user to remain authenticated permanently.

Objects

API Key

Path Type Format Description
id String Version 4 UUID The API key ID
created String ISO 8601 timestamp The instant when the API key was created
lastModified String ISO 8601 timestamp The instant when the API key was last modified
name String   The API key name
clientId String   The API key client ID
profileId String   The API key owner profile ID 
{
  "id" : "1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb",
  "created" : "2023-03-23T21:44:29.955265",
  "lastModified" : "2023-03-23T21:44:29.955265",
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)",
  "clientId" : "y6UGhv0CfYRBJ4ZYwqIdQLZNtVecdJEf",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "update apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "delete apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "profile" : {
      "href" : "https://catalog.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

Requests

View all API keys

GET

/api/apikeys

Returns all API keys owned by the authenticated user profile.

Prerequisites

  • The authenticated user must own a Matatika account
  • The API key {apikey-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/apikeys/' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/apikeys/"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

API key collection with HAL links.

{
  "_embedded" : {
    "apikeys" : [ {
      "id" : "b6034c6c-044c-47e8-8804-922b33dc6a57",
      "created" : "2023-03-23T21:44:27.8832",
      "lastModified" : "2023-03-23T21:44:27.883201",
      "name" : "default",
      "clientId" : "HVsqtLlAwO4REBGOQygA8N2KeVk1j1mF",
      "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/apikeys/b6034c6c-044c-47e8-8804-922b33dc6a57"
        },
        "update apikey" : {
          "href" : "https://catalog.matatika.com/api/apikeys/b6034c6c-044c-47e8-8804-922b33dc6a57"
        },
        "delete apikey" : {
          "href" : "https://catalog.matatika.com/api/apikeys/b6034c6c-044c-47e8-8804-922b33dc6a57"
        },
        "profile" : {
          "href" : "https://catalog.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
        }
      }
    }, {
      "id" : "1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb",
      "created" : "2023-03-23T21:44:29.955265",
      "lastModified" : "2023-03-23T21:44:29.955265",
      "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)",
      "clientId" : "y6UGhv0CfYRBJ4ZYwqIdQLZNtVecdJEf",
      "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
        },
        "update apikey" : {
          "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
        },
        "delete apikey" : {
          "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
        },
        "profile" : {
          "href" : "https://catalog.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/apikeys/?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

View an API key

GET

/api/apikeys/{apikey-id}

Returns the API key {apikey-id}.

Prerequisites

  • The authenticated user must own a Matatika account
  • The API key {apikey-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

API key with HAL links.

{
  "id" : "1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb",
  "created" : "2023-03-23T21:44:29.955265",
  "lastModified" : "2023-03-23T21:44:29.955265",
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)",
  "clientId" : "y6UGhv0CfYRBJ4ZYwqIdQLZNtVecdJEf",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "update apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "delete apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "profile" : {
      "href" : "https://catalog.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

Initialise an API key

POST

/api/apikeys

Initialises a new API key.

Prerequisites

  • The authenticated user must own a Matatika account

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/apikeys/' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/apikeys/"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

API key with HAL links.

{
  "id" : "1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb",
  "created" : "2023-03-23T21:44:29.481499524",
  "lastModified" : "2023-03-23T21:44:29.481500024",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "create apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    }
  }
}

Create an API key

PUT

/api/apikeys/{apikey-id}

Creates the API key {apikey-id}.

Prerequisites

  • The authenticated user must own a Matatika account

Request

Body

API key resource.

{
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)"
}

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)"
}'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"

data = {
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

201 Created

API key with HAL links.

{
  "id" : "1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb",
  "created" : "2023-03-23T21:44:29.955264749",
  "lastModified" : "2023-03-23T21:44:29.955265349",
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955)",
  "clientId" : "y6UGhv0CfYRBJ4ZYwqIdQLZNtVecdJEf",
  "clientSecret" : "EJ8pWee9NGSJMq2w1HhG5MJnDW8aMugJFC4OP_Wdd35tGJQmSp-GucNgWdPwx-GC",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "update apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "delete apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "profile" : {
      "href" : "https://catalog.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

Update an API key

PUT

/api/apikeys/{apikey-id}

Updates the API key {apikey-id}.

Prerequisites

  • The authenticated user must own a Matatika account

Request

Body

API key resource.

{
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955) (updated)"
}

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955) (updated)"
}'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"

data = {
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955) (updated)"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

API key with HAL links.

{
  "id" : "1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb",
  "created" : "2023-03-23T21:44:29.955265",
  "lastModified" : "2023-03-23T21:44:31.670003547",
  "name" : "SIT-generated api key (2023-03-23T21:44:29.660955) (updated)",
  "clientId" : "y6UGhv0CfYRBJ4ZYwqIdQLZNtVecdJEf",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "update apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "delete apikey" : {
      "href" : "https://catalog.matatika.com/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"
    },
    "profile" : {
      "href" : "https://catalog.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

Delete an API key

DELETE

/api/apikeys/{apikey-id}

Deletes the API key {apikey-id}.

Prerequisites

  • The authenticated user must own a Matatika account
  • The API key {apikey-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com:443/api/apikeys/1a851f62-cdf5-4ca9-98a6-6b6307c3fbfb"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.