Workspace erstellen - Square Cloud

POST

workspaces

Workspace erstellen

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces"

payload = { "name": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
        "name": "Test"
    }
}

string

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Erstellt einen Workspace im Besitz des authentifizierten Benutzers, sodass Anwendungen mit anderen Square Cloud-Konten über ein rollenbasiertes Berechtigungsmodell geteilt werden können, anstatt das Eigentum zu übertragen. Workspaces sind nur in den Plänen Standard, Pro und Enterprise verfügbar; in diesem gesamten Bereich ist ein Konto auf 5 Workspaces begrenzt. name muss 1-32 Zeichen lang sein (Buchstaben, Zahlen, Leerzeichen, Bindestriche oder Unterstriche). Verwende nach dem Erstellen eines Workspace Anwendung hinzufügen, um Anwendungen damit zu teilen, und Mitglied einladen, um Mitarbeiter hinzuzufügen. Dieser Endpoint ist auf 1 Erstellung alle 10 Sekunden pro Benutzer begrenzt.

Parameter

string

Eine Zeichenkette, die den Namen des Workspace angibt.
Muss dem Muster a bis z, A bis Z, 0 bis 9, Leerzeichen und _ entsprechen. (1-32 Zeichen)

Antwort

string

Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Die ID des Workspace.

string

Der Name des Workspace.

{
    "status": "success",
    "response": {
        "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
        "name": "Test"
    }
}

Häufige Fehler

Code	HTTP	Bedeutung
`INVALID_NAME`	400	`name` fehlt oder entspricht nicht dem 1-32-Zeichen-Muster.
`UPGRADE_REQUIRED`	403	Der aktive Plan ist nicht Standard, Pro oder Enterprise.
`WORKSPACE_LIMIT_REACHED`	400	Das Konto hat bereits die maximale Anzahl an Workspaces für den Plan erreicht.
`WORKSPACE_CREATION_FAILED`	400	Der Workspace konnte nicht erstellt werden.

Zurück

Workspace löschenLöscht den Workspace.

Weiter

Workspace erstellen

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces"

payload = { "name": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
        "name": "Test"
    }
}

​Parameter

​Antwort

​Häufige Fehler

Parameter

Antwort

Häufige Fehler