integrations

Connect an integration

Creates the connection. The body depends on the provider:

  • google_drive: { provider, code }, where code is the OAuth code returned to the redirect of connect_link. It is single-use, so the plan allowance is checked before the exchange.
  • rss: { provider, url, id_accounts, template?, publication_type?, auto_publish?, import_image? }. The feed is read once to validate it and to take its title, and every item it already has is recorded as seen — connecting a blog never publishes its back catalogue.
  • woocommerce: { provider, url, consumer_key, consumer_secret }, a read key created by hand in the store. The keys are tried against the store before anything is saved, and an organization can connect several stores: each one takes one integration of the allowance. The approval button (connect_link) does the same without anyone copying a key, and is the better way whenever the store allows it.

Requires the integrations:create permission.

post/organizations/{id_organization}/integrations

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/integrations
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Request body

OR
OR

Example request

{
  "url": "https://blog.cliente.com/feed"
}

Response

Integration connected

Example response

{
  "integration": {
    "name": "Drive de ana@empresa.com",
    "external_identifier": "ana@empresa.com",
    "config": {
      "key_ending": "3f9a2c1",
      "currency": "EUR"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.