Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

https://digitalsero-develop-api.b5digital.dk

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

AccessRequests

List All AccessRequests

requires authentication

Example request:

curl --request GET \
    --get "https://digitalsero-staging-api.b5digital.dk/api/access-requests/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/list',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-fe-build-version: 21
vary: Origin


{
    "type": "UNAUTHENTICATED",
    "message": "Authentication failed. Please check your credentials and try again.",
    "details": [],
    "trace": ""
}

Received response:

Request failed with error:

Send Email to Client with Access Request Link

requires authentication

Example request:

curl --request POST \
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/send-email" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requestId\": \"\\\"b90eac01-12c1-4d3f-a0aa-df230c76fa79\\\"\",
    \"email\": \"hello@gmail.com\"
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/send-email',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requestId' => '"b90eac01-12c1-4d3f-a0aa-df230c76fa79"',
            'email' => 'hello@gmail.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/send-email"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requestId": "\"b90eac01-12c1-4d3f-a0aa-df230c76fa79\"",
    "email": "hello@gmail.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

List AccessRequests For Datatable

requires authentication

Example request:

curl --request GET \
    --get "https://digitalsero-staging-api.b5digital.dk/api/access-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-fe-build-version: 21
vary: Origin


{
    "type": "UNAUTHENTICATED",
    "message": "Authentication failed. Please check your credentials and try again.",
    "details": [],
    "trace": ""
}

Received response:

Request failed with error:

Add AccessRequest

requires authentication

Example request:

curl --request POST \
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"providers\": [
        {
            \"id\": \"ut\",
            \"email\": \"emmalee.damore@example.org\",
            \"assets\": [
                {
                    \"type\": \"soluta\",
                    \"role\": \"qui\",
                    \"manager\": {
                        \"id\": \"non\",
                        \"name\": \"minima\"
                    }
                }
            ]
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'providers' => [
                [
                    'id' => 'ut',
                    'email' => 'emmalee.damore@example.org',
                    'assets' => [
                        [
                            'type' => 'soluta',
                            'role' => 'qui',
                            'manager' => [
                                'id' => 'non',
                                'name' => 'minima',
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "providers": [
        {
            "id": "ut",
            "email": "emmalee.damore@example.org",
            "assets": [
                {
                    "type": "soluta",
                    "role": "qui",
                    "manager": {
                        "id": "non",
                        "name": "minima"
                    }
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/access-requests

Body Parameters

providers object[] optional

providers[].id string

providers[].businessManagerId string optional

This field is required when providers.*.id is META.

providers[].businessManagerName string optional

This field is required when providers.*.id is META.

providers[].email string optional

This field is required when providers.*.id is GOOGLE. Must be a valid email address.

providers[].externalUserId string optional

This field is required when providers.*.id is LINKED_IN.

providers[].businessCenterId string optional

This field is required when providers.*.id is TIKTOK.

providers[].businessCenterName string optional

This field is required when providers.*.id is TIKTOK.

providers[].assets object[] optional

providers[].assets[].type string

providers[].assets[].role string optional

This field is required when providers..assets..manager is not present.

providers[].assets[].manager object optional

providers[].assets[].manager.id string optional

providers[].assets[].manager.name string optional

Delete AccessRequest

requires authentication

Example request:

curl --request DELETE \
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
     "data": {
         "message": "access_request deleted successfully",
         "data": null,
     }
 }

Received response:

Request failed with error:

List Request assets for given providers

requires authentication

Example request:

curl --request GET \
    --get "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/assets?providers=META%2CGOOGLE" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"providerIds\": [
        \"illo\"
    ]
}"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/assets',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'providers'=> 'META,GOOGLE',
        ],
        'json' => [
            'providerIds' => [
                'illo',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/assets"
);

const params = {
    "providers": "META,GOOGLE",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "providerIds": [
        "illo"
    ]
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Request assets listed successfully",
    "data": [
        {
            "id": "GOOGLE",
            "types": [
                {
                    "type": "GOOGLE_ADS",
                    "assets": [
                        {
                            "id": 1,
                            "name": "Google Ads Account"
                        }
                    ],
                    "error": ""
                }
            ]
        }
    ]
}

Received response:

Request failed with error:

Show AccessRequest As Client

requires authentication

Example request:

curl --request GET \
    --get "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "type": "UNKNOWN",
    "message": "Invalid Host \"{agencysubdomain}.digitalsero-staging-api.b5digital.dk\".",
    "details": [],
    "trace": ""
}

Received response:

Request failed with error:

Show AccessRequest

requires authentication

Example request:

curl --request GET \
    --get "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-fe-build-version: 21
vary: Origin


{
    "type": "UNAUTHENTICATED",
    "message": "Authentication failed. Please check your credentials and try again.",
    "details": [],
    "trace": ""
}

Received response:

Request failed with error:

POST api/access-requests/{requestId}/grant-access

requires authentication

Example request:

curl --request POST \
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/grant-access" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requestId\": \"a245cd48-593e-38fb-a568-092dfa512b09\",
    \"providers\": [
        {
            \"id\": \"beatae\",
            \"assetTypes\": [
                {
                    \"type\": \"nemo\",
                    \"assets\": [
                        {
                            \"id\": \"imj\",
                            \"name\": \"pbelnlocjgflyjepchxrbximpabuuwivyjzebrfrmwgghmlvjhpoikgqwmjp\",
                            \"businessCenterId\": \"xuhcg\",
                            \"business\": {
                                \"id\": \"phlwiqkdsy\",
                                \"name\": \"hhvfpvwzepurkjgnxbiuauggojlhytvthvmwvjiovctwqwwngrgwykajryznekhssjchssdvvc\"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/grant-access',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requestId' => 'a245cd48-593e-38fb-a568-092dfa512b09',
            'providers' => [
                [
                    'id' => 'beatae',
                    'assetTypes' => [
                        [
                            'type' => 'nemo',
                            'assets' => [
                                [
                                    'id' => 'imj',
                                    'name' => 'pbelnlocjgflyjepchxrbximpabuuwivyjzebrfrmwgghmlvjhpoikgqwmjp',
                                    'businessCenterId' => 'xuhcg',
                                    'business' => [
                                        'id' => 'phlwiqkdsy',
                                        'name' => 'hhvfpvwzepurkjgnxbiuauggojlhytvthvmwvjiovctwqwwngrgwykajryznekhssjchssdvvc',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/grant-access"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requestId": "a245cd48-593e-38fb-a568-092dfa512b09",
    "providers": [
        {
            "id": "beatae",
            "assetTypes": [
                {
                    "type": "nemo",
                    "assets": [
                        {
                            "id": "imj",
                            "name": "pbelnlocjgflyjepchxrbximpabuuwivyjzebrfrmwgghmlvjhpoikgqwmjp",
                            "businessCenterId": "xuhcg",
                            "business": {
                                "id": "phlwiqkdsy",
                                "name": "hhvfpvwzepurkjgnxbiuauggojlhytvthvmwvjiovctwqwwngrgwykajryznekhssjchssdvvc"
                            }
                        }
                    ]
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/access-requests/{requestId}/grant-access

URL Parameters

requestId string

Body Parameters

requestId string

validation.uuid.

providers object[] optional

providers[].id string

providers[].assetTypes object[] optional

providers[].assetTypes[].type string

providers[].assetTypes[].assets object[] optional

providers[].assetTypes[].assets[].id string

Must not be greater than 50 characters.

providers[].assetTypes[].assets[].name string optional

Must not be greater than 255 characters.

providers[].assetTypes[].assets[].businessCenterId string optional

This field is required when providers.*.id is TIKTOK. Must not be greater than 50 characters.

providers[].assetTypes[].assets[].business object optional

providers[].assetTypes[].assets[].business.id string optional

Must not be greater than 50 characters.

providers[].assetTypes[].assets[].business.name string optional

Must not be greater than 255 characters.

Clone Access Request

requires authentication

Example request:

curl --request POST \
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/clone" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/clone',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/clone"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:

POST api/access-requests/{requestId}/request-access

requires authentication

Example request:

curl --request POST \
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/request-access" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requestId\": \"5af8c43c-176e-3472-ba65-1f037655e9ac\",
    \"providers\": [
        {
            \"id\": \"qui\",
            \"assetTypes\": [
                {
                    \"type\": \"culpa\",
                    \"assets\": [
                        {
                            \"id\": \"tquiwziboxhblfaiaalntbym\",
                            \"name\": \"pbyntabxrvmhvntaojtvhckaxnwhoccizqsrizccxtsqzqfzatwxdgoepbptztbntqvawwsfvjnapbnezgjrjtajppxbnuuvgcrhmzzjckljixdfjcvaxlntcqkhprpgkycaghfpq\",
                            \"businessCenterId\": \"la\",
                            \"business\": {
                                \"id\": \"uvytmfdjlhimibpzpletbhzekdjzhtcnqjvzkkcdnqzf\",
                                \"name\": \"vrjpfoiiphwczwzhpeffuwomteztajskigvnbngfbffbzehlptismelghxkvufvyasqzbxdicm\"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/request-access',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requestId' => '5af8c43c-176e-3472-ba65-1f037655e9ac',
            'providers' => [
                [
                    'id' => 'qui',
                    'assetTypes' => [
                        [
                            'type' => 'culpa',
                            'assets' => [
                                [
                                    'id' => 'tquiwziboxhblfaiaalntbym',
                                    'name' => 'pbyntabxrvmhvntaojtvhckaxnwhoccizqsrizccxtsqzqfzatwxdgoepbptztbntqvawwsfvjnapbnezgjrjtajppxbnuuvgcrhmzzjckljixdfjcvaxlntcqkhprpgkycaghfpq',
                                    'businessCenterId' => 'la',
                                    'business' => [
                                        'id' => 'uvytmfdjlhimibpzpletbhzekdjzhtcnqjvzkkcdnqzf',
                                        'name' => 'vrjpfoiiphwczwzhpeffuwomteztajskigvnbngfbffbzehlptismelghxkvufvyasqzbxdicm',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/access-requests/01a9af28-3ee1-4529-8a79-af6f5a447ba9/request-access"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requestId": "5af8c43c-176e-3472-ba65-1f037655e9ac",
    "providers": [
        {
            "id": "qui",
            "assetTypes": [
                {
                    "type": "culpa",
                    "assets": [
                        {
                            "id": "tquiwziboxhblfaiaalntbym",
                            "name": "pbyntabxrvmhvntaojtvhckaxnwhoccizqsrizccxtsqzqfzatwxdgoepbptztbntqvawwsfvjnapbnezgjrjtajppxbnuuvgcrhmzzjckljixdfjcvaxlntcqkhprpgkycaghfpq",
                            "businessCenterId": "la",
                            "business": {
                                "id": "uvytmfdjlhimibpzpletbhzekdjzhtcnqjvzkkcdnqzf",
                                "name": "vrjpfoiiphwczwzhpeffuwomteztajskigvnbngfbffbzehlptismelghxkvufvyasqzbxdicm"
                            }
                        }
                    ]
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/access-requests/{requestId}/request-access

URL Parameters

requestId string

Body Parameters

requestId string

validation.uuid.

providers object[] optional

providers[].id string

providers[].assetTypes object[] optional

providers[].assetTypes[].type string

providers[].assetTypes[].assets object[] optional

providers[].assetTypes[].assets[].id string

Must not be greater than 50 characters.

providers[].assetTypes[].assets[].name string optional

Must not be greater than 255 characters.

providers[].assetTypes[].assets[].businessCenterId string optional

This field is required when providers.*.id is TIKTOK. Must not be greater than 50 characters.

providers[].assetTypes[].assets[].business object optional

providers[].assetTypes[].assets[].business.id string optional

Must not be greater than 50 characters.

providers[].assetTypes[].assets[].business.name string optional

Must not be greater than 255 characters.

Agencies

Agency profile

requires authentication

Example request:

curl --request GET \
    --get "https://digitalsero-staging-api.b5digital.dk/api/agencies/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://digitalsero-staging-api.b5digital.dk/api/agencies/me',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/agencies/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-fe-build-version: 21
vary: Origin


{
    "type": "UNAUTHENTICATED",
    "message": "Authentication failed. Please check your credentials and try again.",
    "details": [],
    "trace": ""
}

Received response:

Request failed with error:

Update My Agency

requires authentication

Example request:

curl --request PUT \
    "https://digitalsero-staging-api.b5digital.dk/api/agencies/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Agency name\",
    \"whitelabellingEnabled\": true,
    \"fontColor\": \"#fff\",
    \"whitelabellingSettings\": {
        \"invertColor\": false,
        \"isDark\": true
    },
    \"subdomainEnabled\": true,
    \"primaryColor\": \"#fff\",
    \"backgroundColor\": \"#fff\"
}"

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://digitalsero-staging-api.b5digital.dk/api/agencies/me',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Agency name',
            'whitelabellingEnabled' => true,
            'fontColor' => '#fff',
            'whitelabellingSettings' => [
                'invertColor' => false,
                'isDark' => true,
            ],
            'subdomainEnabled' => true,
            'primaryColor' => '#fff',
            'backgroundColor' => '#fff',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://digitalsero-staging-api.b5digital.dk/api/agencies/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Agency name",
    "whitelabellingEnabled": true,
    "fontColor": "#fff",
    "whitelabellingSettings": {
        "invertColor": false,
        "isDark": true
    },
    "subdomainEnabled": true,
    "primaryColor": "#fff",
    "backgroundColor": "#fff"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

PUT api/agencies/me

Body Parameters

name string optional

whitelabellingEnabled boolean optional

fontColor string optional

whitelabellingSettings object optional

whitelabellingSettings.primaryColor string optional