Developer platform

Developer tutorials: from onboarding to uninstall

Step by step through what you need to do: onboarding, signing, building, integrating, review, publishing, installation, calling the API, upgrading and uninstalling. Each kind’s fields and rules are in the guides by kind.

  1. 1Onboarding and teamThree scopes first: developers publish plugins, a customer’s administrator buys, installs and authorises them in their own control plane, and ordinary users only use what the administrator opens. Onboarding covers the first one.
  2. 2Tools and publisher keycdnca-plugin is one offline executable that only touches local files: it does not sign in, upload or review. One publisher key is used for the long term; do not create a new one per version.
  3. 3Build your first pluginWalk through “create plugin → generate project → check and preview → pack and sign” with a theme, then see how other kinds differ in manifest and upload files.
  4. 4Local integrationThemes and rule packs are prechecked locally; plugins with a service must get protocol, signatures and idempotency right locally before a customer installs them. Four kinds of credential exist and none replaces another.
  5. 5Upload and reviewUpload on the plugin’s “Versions” tab, wait for the scan, then see whether human review applies. “Uploaded, scanning” is not approval, let alone visible to customers.
  6. 6Publishing, channels and pricingAfter approval the owner publishes; whether customers can get it also depends on an active price plan. A free plugin needs an active plan with amount zero too.
  7. 7Installation and authorisationYou provide documentation, support and service addresses; buying, confirming and authorising are done by the customer’s administrator in their own control plane. Downloaded, confirmed and enabled are three different states.
  8. 8Calling the open APIOperations accept different authentication, so read the operation detail first. An external service calls a customer’s control plane only with an API key the customer issued, and only on operations marked “API key”.
  9. 9Upgrade and uninstallDevelopers can only upload new versions and hide versions; upgrading, disabling and uninstalling are done by the customer’s installation manager. Clear migration notes on every version are what make upgrades safe.