Skip to content

⚙️ Prerequisites & Configuration

Everything you need before your first API call

The Bottom Line

Before you integrate, you need three things:

  1. API credentials - your clientId and clientSecret
  2. The correct Base URL for your environment
  3. The Auth URL for your environment

This page brings them together in one place - no fishing them out of Swagger's "Try it out". On your own LIKE MAGIC environment the URLs are even filled in automatically.

Prerequisites

Requirement How to Get It
Service account credentials (clientId and clientSecret) Created by your LIKE MAGIC Account Admin - see Manage Service Accounts
Assigned scopes Pre-configured on your service account - see Authentication
Base URL and Auth URL Tenant-specific - see Tenant Configuration below

Tenant Configuration

The Base URL and Auth URL are specific to your tenant, and this page fills them in for you automatically when it is opened from your own environment. On the central docs they show the URL pattern instead.

Open these docs on your own environment

We strongly suggest heading over to your tenant's own copy of this documentation now, to see it filled with your tenant-specific URLs and eliminate any guessing:

https://monitoring.<your-domain>/api-doc/guide/setup/prerequisites/

Just swap in your <your-domain> and read the values straight off the table below.

Setting Value Used For
Base URL Prefix for every API request - append /api/<service>/...
Auth URL (token endpoint) OAuth 2.0 token exchange - POST your credentials here
OpenID Configuration Auto-discovery for OAuth2 clients (n8n, Postman and more)

When shown as a pattern, the three placeholders mean:

  • <your-domain> - Your tenant's own domain (for example example.com).
  • <auth-server> - Your Keycloak identity-provider host, assigned by LIKE MAGIC during onboarding. It usually starts with https://idp. (often https://idp.<your-domain>).
  • <tenant> - Your realm name (your tenant identifier).

💡 Setting up OAuth2 in a tool like n8n? Point it at the OpenID Configuration URL. The tool discovers the token endpoint and the rest of the OAuth2 settings automatically - no manual entry required.

Getting Your URLs

If the values above show patterns rather than your live URLs, you are on the central docs at api-docs.likemagic.tech, which is not tied to a single tenant. Get your real URLs in any of these ways:

  1. Open the docs from your own environment - Loading this page from your monitoring host (https://monitoring.<your-domain>/api-doc/...) auto-fills every value.
  2. Check the Operations Platform - Open Settings → Service Accounts; your Base URL and Auth URL are shown there.
  3. Ask your LIKE MAGIC contact - They can confirm your domain, identity-provider host and realm name.

Easiest path for the Auth URL: let your OAuth2 client discover everything from the OpenID Configuration, or read the token_endpoint field from it directly - no need to assemble the URL by hand.

Quick Test

Confirm your configuration end to end - first get a token, then call an API.

1. Get a token

curl --location '{{tokenEndpoint}}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'client_id=YOUR_CLIENT_ID' \
  --data-urlencode 'client_secret=YOUR_CLIENT_SECRET'

2. Call an API

curl --location '{{monitoringUrl}}/api/<service>/...' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace <service> with the API you're calling (for example task-management-service) and ... with the endpoint path - see the API Reference. A 200 OK means your credentials, Base URL and Auth URL are all correct. See Authentication for the full token flow and troubleshooting.

Next Steps

Guide What You Get
🔐 Authentication Full OAuth 2.0 token flow, caching and security best practices
🔑 Manage Service Accounts Create credentials and assign scopes
⚡ Manage Webhook Subscriptions Subscribe to business events

Got your URLs and credentials? Head to the 🔐 Authentication Guide and make your first call. 🚀