WordPress integration

Connect the Tarkle WordPress plugin with an API token to embed transfers and file requests on your site.

Updated Nov 2, 20263 min read
WordPress integration

The WordPress integration connects the Tarkle WordPress plugin to your workspace, so the plugin can embed your transfers and file requests on your WordPress site. The plugin connects with an API token that you create in Tarkle.

Create an API token for WordPress

The WordPress panel shows Connected as soon as the workspace has an API token that has not been revoked. If no token is listed yet, follow these steps.

  1. Open Integrations in Settings and find WordPress in the list. The WordPress panel lists the setup steps.

  2. Click Go to Developers. The Developers page opens on the API Tokens tab.

  3. Click New token.

  4. In the Create API token dialog, type a Token name, for example WordPress Integration.

  5. Leave the boxes under Public API access unchecked. The WordPress plugin does not need any access. For the scopes behind those boxes, read the Brand API quick start.

  6. Click Create.

  7. In Token created, click the box under Token (shown once) to copy the token, then click Done.

  8. Paste the token in your WordPress plugin settings.

The token is shown only once, so copy it and save it in a secure location before you click Done.

Check the connection

Once a token exists, the WordPress panel lists it under Active API token. The panel shows the newest token that has not been revoked. Any token in the workspace appears there, including one made for another purpose, so keep that in mind when you choose the token for WordPress.

  • Name and Token: the token name, and the first characters of the token followed by dots.

  • Created, and Last used, which appears once the plugin has used the token.

  • Connected domains: the first WordPress site that called Tarkle, shown as Connected to followed by its domain. When more sites connect, the panel adds a count, for example and 1 other or and 2 others. Until a site connects, the panel shows Waiting for WordPress plugin to connect...

Use Manage token to open the API Tokens tab, where you rename, revoke and create tokens.

Replace or disconnect a token

To replace a token, create a new one as described above and paste it in your WordPress plugin settings. Then revoke the old token. On the API Tokens tab, open the three-dot menu on the token's row, click Revoke, and click Revoke again in the dialog. A revoked token no longer works, so the plugin's next request is refused.

Click Disconnect in the WordPress panel to clear the connected domains. Disconnect does not revoke the token. To stop the plugin from using it, revoke the token on the API Tokens tab.

A workspace under a reseller partner that hides WordPress cannot load WordPress status.

What the plugin can embed

These rules apply to what the plugin can embed.

  • A transfer must be public. Only public transfers can be embedded on WordPress. A transfer that is disabled, expired or already burned cannot be embedded either.

  • A download embed works only for transfers set to direct download. For more on direct download links, read Direct download links in Tarkle.

  • Each embed link is signed for 10 minutes.

What happens next

Once a WordPress site connects with the token, its domain appears under Connected domains in the WordPress panel.

Related articles

More in Integrations