Systems

This endpoint allows you to fetch data about the defined Systems of your Team.

Read All Systems

GEThttps://integration.goodaccess.com/api/v1/systems

Authorization

bearerAuth

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration.goodaccess.com/api/v1/systems', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "412345eee-d1f1-1234-1ab1-123bee1234f12",
    "name": "EXAMPLE-SYSTEM",
    "icon": "https://example.com",
    "is_valid": 1,
    "custom_port": "8080",
    "host": "https://example.com",
    "uri": "https://example.com",
    "access_cards": []
  }
]

Read System

GEThttps://integration.goodaccess.com/api/v1/system/<system-id>

Authorization

bearerAuth

Response

200404

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration.goodaccess.com/api/v1/system/<system-id>', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200404

{
  "id": "69f25acc-7eb8-494b-bb64-7671b5726e2d",
  "created_at": "2024-08-15 10:48:44",
  "name": "GoodAccess System",
  "is_valid": true,
  "port": "8080",
  "host": "goodaccess.com",
  "uri": "https://goodaccess.com"
}

Create System

POSThttps://integration.goodaccess.com/api/v1/system

Authorization

bearerAuth

Body

application/json

object

Example: {"name":"GoodAccess Example System","host":"https://goodaccess.com","uri":"https://goodaccess.com","port":"8080","protocol":"UDP"}

Response

200409

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration.goodaccess.com/api/v1/system', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "GoodAccess Example System",
      "host": "https://goodaccess.com",
      "uri": "https://goodaccess.com",
      "port": "8080",
      "protocol": "UDP"
    }),
});
const data = await response.json();

Response

200409

{
  "created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "message": "System created successfully"
}

Update System

PUThttps://integration.goodaccess.com/api/v1/system/<system-id>

Authorization

bearerAuth

Body

application/json

object

Example: {"name":"GoodAccess Example System","host":"https://goodaccess.com","uri":"https://goodaccess.com","port":"8080","protocol":"UDP"}

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration.goodaccess.com/api/v1/system/<system-id>', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "GoodAccess Example System",
      "host": "https://goodaccess.com",
      "uri": "https://goodaccess.com",
      "port": "8080",
      "protocol": "UDP"
    }),
});
const data = await response.json();

Response

200

{
  "message": "System updated successfully"
}

Remove System

DELETEhttps://integration.goodaccess.com/api/v1/system/<system-id>

Authorization

bearerAuth

Response

200404

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://integration.goodaccess.com/api/v1/system/<system-id>', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200404

{
  "message": "System removed successfully"
}