Configure API Cloud Link

Last Updated: April 28, 2026

Here are the steps to configure API Cloud Link in your environment.

Key Points

  • Review the Requirements before configuring this feature.
  • API Cloud Link supports RESTful API requests and IPP printing requests.
  • API Tokens support both request types.
  • OAuth 2.0 supports RESTful API requests.
  • API Cloud Link only requires an API Token or OAuth 2.0 Client ID and Secret.
    • Select from one option or the other depending on your environment's security guidelines.

API Requests

The endpoint structure used for API requests depends on whether you are using a RESTful API or IPP printing. Use the appropriate endpoint below when configuring this service.

RESTful API Requests

The endpoint must be adjusted for your region.

 

Copy Code

Endpoint

https://external-api.app.printercloud.com/v1/print

RESTful API requests support API Tokens and OAuth 2 tokens to authenticate requests from external applications or tools. Use the appropriate steps in the 2. Configure Authentication section when setting up your authentication method. RESTful API requests require the following HTTP headers.

Copy Code
Example
Authorization: "<API or JWT token>"
X-Site-ID: "<Your_Instance_Subdomain>"

IPP Printing Requests

The endpoint must be adjusted for your region.

 

Copy Code

Endpoint

https://external-api.app.printercloud.com/v1/ipp/print/<Printer Name>

IPP Printing requests require an API Token to authenticate requests from external applications or tools. Use the API Token steps in the 2. Configure Authentication section when setting up your authentication method. API requests require the following HTTP header.

Copy Code
Example
Authorization: "<API token>"

If you are configuring API Cloud Link using IPP print jobs request for Oracle Fusion, complete the Enable API Cloud Link and API Tokens sections below, then proceed to Connect Oracle Fusion.

  1. In the Admin Console, go to the API Cloud Printing section on Tools then Settings then Output.
  2. Select API Cloud Link Enabled.
  3. Select Save in the upper-right corner.

API Cloud Printing setting as seen in the Admin Console.

2. Configure Authentication

Follow the steps in the appropriate section below when setting up your authentication method.

API Cloud Link only requires an API Token or OAuth 2.0 Client ID and Secret. Select the appropriate option based on your environment's security guidelines.

API Tokens

  1. Go to Tools then Tokens then API Keys.
  2. Select the API Keys tab.

  3. Select the Generate button in the upper-left.

    Newly generated API Keys appear at the bottom of the Active API Keys list.

  4. Copy the token for the newly created API Key.

API Keys window showing the Generate button and the Active API Keys section.

Add the API key into the request HTTP header to authenticate requests from external applications and tools. For more details refer to API Cloud Link Schemas.

OAuth 2 Authentication

  1. Go to Tools then Tokens then API Keys.
  2. Select the OAuth 2.0 tab.
  3. Select the Register Client button in the upper-right.
  4. Enter a Display Name and Integration Purpose (Description).

  5. Use the dropdown to select the Client Secret Expiration.

    Register Client modal showing the name, description, and time-length for token fields.

  6. Select Create.

  7. On the Register Client modal, copy the Client ID and Client Secret or download / copy the JSON format.

    Register Client modal showing the Client ID and Secret, along with the download options.

    The client secret will only be displayed once and will not be visible again. If you lose the secret, you will need to either rotate the existing secret or create a new one.

  8. Send a POST request to the validate client endpoint with the Client ID, Client Secret, and audience in the request body to obtain an access token.

    1. The response contains a JSON Web Token (JWT) that serves as your access token.
    Copy Code
    Endpoint
    https://external-api.app.printercloud.com/v1/oauth2/validate-client
    The endpoint must be adjusted for your region.
  9. Include the following headers when sending the POST request.
    1. Content-Type: Application/json

    2. X-Site-ID: The subdomain of your Vasion instance. (e.g., acmeco.printercloud.com would be "acmeco")

      Copy Code
      Content-Type: application/json
      X-Site-ID: "<Instance_Subdomain>"
      {
        "client_uuid": "<Your_Client_ID>",
        "client_secret": "<Your_Client_Secret>",
        "audience": "all"
      }

      The audience value is from the JSON token.

    3. Response example:

      Copy Code
      {
          "access_token": "eyJhbGciOiJSUzI1NiIs...",
          "token_type": "Bearer",
          "expires_in": 1800
      }
  10. Select Done in the Admin Console when finished.

Rotate Client Secrets

If you lose your OAuth 2.0 client secret or the existing one is expiring, use the steps below to rotate the secret and set the Grace Period. The Grace Period is the time during which both secrets are valid, allowing a buffer while updating your configuration with the new secret.

  1. Go to Tools then Tokens then API Keys.
  2. Select the OAuth 2.0 tab.

  3. Select the three dots to the right of the OAuth 2.0 line item.

    OAuth screen showing the right-side menu expanded to show additonal options.

  4. Select Rotate Secret.

  5. In the Rotate client secret for... modal, use the dropdowns to select:

    1. Client Secret Expiration for the secret.
    2. Grace Period where both secrets are active.

    Rotate modal showing the fields to adjust the new expiration.

  6. Select Rotate.

  7. On the Rotate Secret modal, copy the Client ID and Client Secret or download / copy the JSON format.

    The client secret will only be displayed once and will not be visible again. If you lose the secret, you will need to either rotate the existing secret or create a new one.

  8. Paste these values into your application's OAuth 2.0 Client configuration section. The location differs depending on the tool used.
  9. Select Done when finished.

Register Client modal showing the Client ID and Secret, along with the download options.

During an active grace period, you can monitor the expiration by selecting the arrow next to the Name to expand and show the previous client secret information.

OAuth 2.0 tab showing two applications and the grace period counter showing for one.

Next Steps

Troubleshooting Help