sites

Inserir uma imagem em um campo de imagem

Insere uma imagem em um campo de imagem dos detalhes da empresa ou de uma entrada, com seu texto alternativo, em UM único registro do histórico, e inicia a compilação. A imagem pode ser um arquivo da mídia do site (media_path), um resultado de banco de imagens escolhido por você (stock_id) ou uma descrição pesquisada na biblioteca gratuita de imagens (query; importa o primeiro resultado com os créditos). Grátis: imagens de bancos de imagens não custam créditos.

POST/v1/sites/{site_id}/images:place

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/images:place' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "target": "<string>",
  "alt": "<string>"
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/images:place"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"target\":\"<string>\",\"alt\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/images:place", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "target": "<string>",
    "alt": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>/images:place");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"target\":\"<string>\",\"alt\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://api.atelier201.com/v1/sites/<site_id>/images:place", bytes.NewBuffer([]byte("{\"target\":\"<string>\",\"alt\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>/images:place"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"target\":\"<string>\",\"alt\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>/images:place")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"target\":\"<string>\",\"alt\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "target": "<string>",
    "image": "<string>",
    "alt": "<string>",
    "alt_field": null,
    "credit": null,
    "revision": "<string>",
    "changed": true,
    "build": {
      "id": "<string>",
      "state": "<string>",
      "next_action": "<string>"
    },
    "next_action": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Requer sites:write. Não custa créditos. O caminho termina em /images:place. Altera apenas o rascunho. Os visitantes só verão as alterações quando você publicar.

Uma chamada para “inserir uma foto aqui”. target é o campo de imagem: business:/hero/image para a imagem da página inicial ou <collection>/<slug>:/image para uma entrada, como services/sourdough:/image. O modelo de conteúdo lista os campos de imagem.

Informe exatamente uma origem:

query: uma descrição em inglês, com termos concretos. A biblioteca gratuita de imagens é pesquisada, e o primeiro resultado é importado com os créditos correspondentes. orientation restringe o formato.
stock_id: um resultado escolhido por você usando Pesquisar imagens de banco.
media_path: um arquivo que já está na mídia do site, como uma foto do proprietário.

O valor de alt é salvo no campo de texto alternativo ao lado da imagem, se houver um no conteúdo (por exemplo, imageAlt), e junto ao arquivo de mídia. A alteração cria uma entrada no histórico e inicia a compilação: a resposta inclui build. Se a pesquisa não encontrar resultados, retorna 404 e nada é gravado.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

O id do site ou seu slug (o endereço antes de .atelier201.page).

Corpo

application/jsonrequired

targetstringrequiredlength: 3–200 chars

O campo de imagem: business:/hero/image para os dados da empresa ou /:/image para um registro (services/sourdough:/image). get_content_model mostra os campos de imagem.

altstringrequiredlength: 1–300 chars

O que a imagem mostra, para pessoas que não conseguem vê-la, no idioma do site. O texto é salvo no campo alt ao lado da imagem, quando disponível.

querystringlength: ≤ 100 chars

Uma descrição para buscar na biblioteca de imagens gratuitas, em inglês e com termos concretos ("minimalist concrete house at dusk"): o primeiro resultado é importado.

stock_idstringlength: ≤ 20 chars

O ID de um resultado de search_stock_media, quando você escolheu a imagem.

media_pathstringlength: ≤ 200 chars

Um arquivo que já está na mídia do site (/media/storefront.jpg), por exemplo, uma foto do proprietário.

orientationenum<string>one of: landscape, portrait, square

Com query: o formato da imagem a buscar. Landscape é adequado para uma imagem de destaque.

Resposta

application/json

Inserir uma imagem em um campo de imagem

dataRecord<string, object>required

Show child attributes

data.targetstringrequired

data.imagestringrequired

O caminho /media que está no campo agora.

data.altstringrequired

data.alt_fieldstringnullrequired

Onde o texto alternativo foi salvo, ou null quando o conteúdo não tem um campo de texto alternativo.

data.creditstringnullrequired

data.revisionstringrequiredlength: 40–40 chars

Um ID de commit do Git (40 caracteres hexadecimais) do repositório do site.

data.changedbooleanrequired

data.buildobject | nullrequired

A compilação iniciada (ou associada) por esta alteração: a prévia acompanha essa compilação. Não é necessário chamar build_site.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/images:place' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "target": "<string>", "alt": "<string>" }'

{ "data": { "target": "<string>", "image": "<string>", "alt": "<string>", "alt_field": null, "credit": null, "revision": "<string>", "changed": true, "build": { "id": "<string>", "state": "<string>", "next_action": "<string>" }, "next_action": "<string>" }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Inserir uma imagem em um campo de imagem

Autorizações

Parâmetros de caminho

Corpo

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies