Security change on December 1, 2026: TLS 1.2 will become the minimum standard for 365 business Print Agent. Details and system requirements
365 business development

Playground Quickstart

Learn how to register for an API key, authenticate requests with thekey query parameter, and send your first 365 business API request from the Playground.

RegistrationAPI KeyQuery parameterPlayground

Info

The normal flow is: call the registration endpoint once, copy the API key from the response, then authenticate later requests with ?key={apiKey}.

1. Register and receive an API key
The registration endpoint creates the API key that is used for authenticated calls to the 365 business API.

Open the User endpoints and call POST /api/v1/registration. Enter the company and contact values required for the registration request.

The successful response contains an apiKey. Copy that value and keep it available. It is the value you will use for authentication in the Playground and in your own integrations.

The response can also include information such as a message, notice, and trial period date. Review these fields before you continue with productive requests.

2. Authenticate with the key query parameter
The WebAPI does not use a bearer token. The API key is passed as the query parameter named key.

For direct HTTP calls, append the API key to the request URL:

https://api.365businessapi.com/api/v1/apikeystatus?key={apiKey}

In the Playground, use Authorize and paste only the API key itself. The OpenAPI security scheme is configured as an API key in query, so the Playground adds the key query parameter automatically.

3. Use the Playground to call the API

The Playground lets you send real API requests directly from the documentation. Use it to verify registration, authentication, request payloads, and response formats before you write application code.

  1. Open the endpoint you want to test

    Navigate to an endpoint in the generated reference and open the Playground from there. Start with a simple endpoint and confirm that the request URL points to https://api.365businessapi.com.

  2. Configure the API key

    Use Authorize and paste only the API key value. The OpenAPI definition uses an API key named key in the query string, so the Playground adds key={apiKey} to authenticated requests.

  3. Enter the request values

    Fill in required query parameters, headers, and body fields for the selected endpoint. Keep the key parameter managed through Authorize unless you deliberately want to test a specific URL manually.

  4. Send the request and review the response

    Use Send to call the live API from the docs. Check the status, response body, and error details before you reuse the payload in application code.

Attention

The Playground calls the live API. When you test POST, PUT, PATCH, or DELETE endpoints, you can create, change, or remove real data.

How to enter the API key

Paste only the raw API key into the Playground's Authorize dialog. Do not enter key=, ?key=, or a full URL there.

Info

If you manually add a key query parameter while also using Authorize, the request can contain duplicate authentication values. Prefer one method per request.

Quick Links