Criar espaço de trabalho

POST

workspaces

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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Cria um espaço de trabalho pertencente ao usuário autenticado, permitindo compartilhar aplicações com outras contas Square Cloud sob um modelo de permissões baseado em papéis, em vez de transferir a propriedade. Espaços de trabalho estão disponíveis apenas nos planos Standard, Pro e Enterprise; em todos esses níveis, a conta é limitada a 5 espaços de trabalho. O name deve ter de 1 a 32 caracteres (letras, números, espaços, hifens ou sublinhados). Depois de criar um espaço de trabalho, use Adicionar aplicação para compartilhar aplicações nele e Convidar membro para adicionar colaboradores. Este endpoint é limitado a 1 criação a cada 10 segundos por usuário.

Parâmetros

string

Uma string que representa o nome do espaço de trabalho.
Deve obedecer ao padrão a a z, A a Z, 0 a 9, espaços e _ (1-32 caracteres)

Resposta

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID do Espaço de Trabalho.

string

O nome do Espaço de Trabalho.

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

Erros comuns

Código	HTTP	Significado
`INVALID_NAME`	400	`name` está ausente ou não atende ao padrão de 1 a 32 caracteres.
`UPGRADE_REQUIRED`	403	O plano ativo não é Standard, Pro ou Enterprise.
`WORKSPACE_LIMIT_REACHED`	400	A conta já atingiu o número máximo de espaços de trabalho do plano.
`WORKSPACE_CREATION_FAILED`	400	Não foi possível criar o espaço de trabalho.

Excluir espaço de trabalhoExcluir o espaço de trabalho.

Criar espaço de trabalho

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"
    }
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns