Create an Extension

https://mapi.storyblok.com/v1/org_apps

This endpoint allows you to create an extension inside the organization or partner extensions.

/partner_apps

Request body properties

• app The Extension Object

  The extension object

  Show The Extension Object child properties

  • name required string

    Name of the Extension

  • slug required string

    The slug specific to this Extension

  • icon string

    Icon image path of the Extension from the Extension Details

  • preview_video string

    Define the video URL in the extension configured on the Extension Details in the settings

  • description string

    A description of your extension

  • intro string

    A short description of your extension

  • screenshot string

    A screenshot image path of your extension

  • website string

    Website URL of your extension

  • author string

    Author of the extension

  • field_type_ids number[]

    An array of field type ids

  • embedded_app_url string

    An embedded Space app or Tool Plugin URL

  • dev_embedded_app_url string

    A developer mode of embedded Space Plugin or Tool Plugin URL

  • dev_oauth_redirect_uri string

    A developer mode of OAuth Space Plugin or Tool Plugin URI

  • in_sidebar boolean

    A status in the sidebar if your plugin is a space app

  • in_toolbar boolean

    A status in the toolbar if your plugin is tool plugin

  • sidebar_icon string

    Your space app sidebar icon image path

  • oauth_redirect_uri string

    OAuth Space Plugin or Tool Plugin URI

  • enable_space_settings boolean

    A status to show whether your extension is enabled for space level settings or not

Response properties

• app The Extension Object

  The extension object

Examples

cURL

curl "https://mapi.storyblok.com/v1/org_apps" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"app\":{\"name\":\"My extension\",\"slug\":\"storyblok-gmbh@extension-1\"}}"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('org_apps', {
  "app": {
    "name": "My extension",
    "slug": "storyblok-gmbh@extension-1"
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = ["app" => ["name" => "My extension","slug" => "storyblok-gmbh@extension-1"]];

$client->post('org_apps', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/org_apps")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"app":{"name":"My extension","slug":"storyblok-gmbh@extension-1"}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/org_apps");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"app\":{\"name\":\"My extension\",\"slug\":\"storyblok-gmbh@extension-1\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/org_apps"

querystring = {}

payload = {"app":{"name":"My extension","slug":"storyblok-gmbh@extension-1"}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("POST", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {"app" => {"name" => "My extension","slug" => "storyblok-gmbh@extension-1"}}

client.post('org_apps', payload)

Swift

import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: {"app":{"name":"My extension","slug":"storyblok-gmbh@extension-1"}}.data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/org_apps")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()