API Integration

This guide will show you how to obtain an API token within the GoodAccess Control Panel for accessing the API and performing authorized operations.

This feature is available in the Premium plan and higher.

For more detailed API integration documentation, we recommend visiting the Postman Documentation or downloading the collection and importing it into Postman.

Obtaining API token

Log in to the GoodAccess Control Panel, and go to API Integration.

Here, add a new integration or edit an existing one.

Select scopes of the integration, set expiration and allowed IP addresses, and generate a token.

Additionally, you can monitor the activity and communication of the integration from this interface.

API Integration detail

Please note: Immediately after being generated, you will see the token for a limited period. It is important to save the token in a secure place, as it provides access to the API and can be used to perform operations. After this period has expired, the token will be secured and you won’t be able to access it.

Your token can be used to authorize HTTP requests to the GoodAccess API. Each request must include an Authorization header with the token written as Bearer <token>.

See the examples at the bottom of the page for correct syntax.

Treat your token like a password and store it securely. For example, use the methods env and dotenv to store it in a development environment.

Testing connection to GoodAccess API

To test your API connection, send an authenticated request to the test-connection endpoint. If the connection is successful, you will get a 200 return code.

Test Connection

GEThttps://{{goodaccess_integration_api_base}}/api/v1/test-connection

Authorization

bearerAuth

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://{{goodaccess_integration_api_base}}/api/v1/test-connection', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Below are examples of how to call the test endpoint in various languages via curl.

curl

curl -i https://{{goodaccess_integration_api_base}}/api/v1/test-connection \
  -H "Authorization: Bearer <integration_token>"

Python

import requests

url = 'https://{{goodaccess_integration_api_base}}/api/v1/test-connection'
headers = {
    'Authorization': 'Bearer <integration_token>'
}

response = requests.get(url, headers=headers)

Node

const axios = require('axios');

const url = 'https://{{goodaccess_integration_api_base}}/api/v1/test-connection';
const token = '<integration_token>';

axios.get(url, {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
.then(response => {
 //...
})
.catch(error => {
  //...
});

PHP

<?php

$url = 'https://{{goodaccess_integration_api_base}}/api/v1/test-connection';
$token = '<integration_token>';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Authorization: Bearer ' . $token,
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);

API Reference