Cloud integrations let third-party developers (integrators) use our Cloud Print APIs and Cloud Trigger APIs to interact with your label printing system.
Note
See more about Cloud Triggers in Automation User Guide.
To enable third-party developers using our APIs:
-
Third-party developers must register on our Developer Portal.
-
You must subscribe your third-party developers in Control Center.
To use Cloud trigger APIs, NiceLabel Cloud APIs, and Cloud Print APIs, third-party developers must include subscription keys from our Developer Portal in HTTP requests with custom “Ocp-Apim-Subscription-Key” headers.
Note
You don't need subscription keys if you use your APIs in NiceLabel applications.
In Control Center go to Integrations > Cloud Integrations to see your active and inactive cloud integrations.
To enable third-party developers to use our APIs, your developers need your cloud trigger names (unique for each trigger).
Your developers can also use our built-in load-balancing feature with cloud triggers.
Note
Your subscription keys work for multiple developers. For transparency and security, we recommend you create separate Cloud integrations for each developer. With this method, you can revoke access from single developers by deleting their individual Cloud integrations without affecting access for your other developers.
-
Go to Integrations > Cloud Integrations.
-
Click +Add. The Integrators page opens.
-
Type the Name of your third-party developer.
-
Copy the key.
-
Click Save.
Control Center lists your new developer on the Cloud Integrations page with the status: No developer subscribed.
Note
Your Control Center user account must have manage cloud integrations permissions.
-
Open the Developer Portal in your browser.
-
Click Sign up. The Registration page opens.
-
Enter your information and click Sign up.
-
Go to your email inbox and open the email the Developer Portal sends you (check your Junk folder).
-
Click the confirmation link in the email. Your Developer Portal profile page opens.
Your integrator is registered on the Developer Portal. To use APIs, subscribe to Cloud Print APIs and connect subscriptions to Control Center.
Note
For more information, read the Cloud Triggers section of your Automation user guide.
After your third-party integrators set up Developer Portal accounts, they must subscribe to specific products to use their APIs, and then connect their subscription to Control Center. Subscriptions to Developer Portal products are free and use primary and secondary keys for authentication. For example, to use Control Center APIs, they must subscribe to the Control Center product on the Developer Portal:
-
Sign in to NiceLabel Developer Portal.
-
Go to Products > NiceLabel Cloud.
-
Click Add subscription.
-
Type your subscription name (if you have multiple customers, choose customer-specific names).
-
Click Confirm.
Your developer's profile page opens with the dialogue: You have successfully subscribed to the NiceLabel Cloud product. Try the APIs in this product now. Your developer is subscribed in the Developer Portal, but you must connect their subscription to Control Center before your developer can use Cloud Print API.
Note
Subscribing generates two separate keys. Use them for multiple program versions and added security. If your primary key becomes compromised, use your secondary key and regenerate your primary key. For more information, read the Cloud Triggers section of your Automation user guide.
After your developers register and create subscriptions on Developer Portal, you must connect their subscriptions to Control Center before they can use our APIs in your programs.
-
In Control Center go to Integrations > Cloud Integrations.
-
Find the integrator connected to your Developer Portal subscription, and click Copy the key. Send this key to your third-party developer.
Instructions for your third party developer:
-
Sign in to NiceLabel Developer Portal.
-
Go to Products > NiceLabel Cloud.
-
Click Developer Sign Up API v1.
-
Click Try it.
-
Type or paste your key from Control Center in the IntegratorKey box.
-
Under Authorization, select your primary or secondary subscription key (use primary by default). For multiple customers, make sure you select your correct subscription.
-
Click Send.
When your developer clicks Send, return to Control Center > Integrations > Cloud Integrations and refresh your browser tab. Control Center lists your developer as subscribed.
Your third-party developer is connected and ready to use our APIs.
Note
Your subscription keys work for multiple developers. For transparency and security, we recommend you create separate Cloud integrations for each developer. With this method, you can revoke access from single developers by deleting their individual Cloud integrations without affecting access for your other developers.
To learn more about deploying cloud triggers, read Automation User Guide: Cloud triggers.
To learn more about Cloud Print, read Understanding Cloud Print.
To learn more about Cloud Print API, read Understanding Cloud Print API.