API referansı

Logo görseli API'si API ürünü

Her alan adı için şirket logosunu yerleştirebileceğiniz, önbelleğe alabileceğiniz ve saklayabileceğiniz bir PNG görseli olarak alın. Doğru uç noktayı seçmek ve tam olarak ne döndürdüğünü görmek için bu referansı kullanın.

İşlemler

GET /v1/logo/:domain API referansını görüntüle

GET /v1/logo/:domain

İşlem: getLogoImage Krediler ve kimlik doğrulama: 1 Kimlik doğrulama gerekli
GET /v1/logo/:domain Kredi: 1

Sorgu parametreleri

Parametre Tür gerekli
domain string gerekli
size integer
Varsayılan 128
isteğe bağlı
retina boolean
Varsayılan false
isteğe bağlı
greyscale boolean
Varsayılan false
isteğe bağlı
theme string
İzin verilen değerler lightdark
isteğe bağlı
fallback string
İzin verilen değerler 404monogram
Varsayılan 404
isteğe bağlı
format string
İzin verilen değerler png
Varsayılan png
isteğe bağlı
variant string
İzin verilen değerler squarewide
Varsayılan square
isteğe bağlı
v string isteğe bağlı
token string isteğe bağlı

Yanıt alanları

Alan Tür
body image/png
X-Credits-Charged string
X-Credits-Remaining string
X-RateLimit-Limit string
X-RateLimit-Remaining string
X-RateLimit-Reset string
Cache-Control string
ETag string
Last-Modified string
X-Logo-Status string
X-Logo-Source string
X-Logo-Verification string
X-Logo-Source-Format string
X-Logo-Native-Size string
X-Logo-Theme-Adjusted string
X-Logo-Variant string
X-Logo-Lookup string
X-Cache string
Cloudflare-CDN-Cache-Control string
X-Cache-Age string

Örnek istek

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=example"
const response = await fetch("https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=example", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=example",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=example", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=example")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

Örnek yanıt

HTTP/2 200
content-type: image/png
x-credits-charged: ...
x-credits-remaining: ...
x-ratelimit-limit: ...
x-ratelimit-remaining: ...
x-ratelimit-reset: ...
cache-control: ...
etag: ...
last-modified: ...
x-logo-status: found
x-logo-source: bimi
x-logo-verification: decoded
x-logo-source-format: ...
x-logo-native-size: ...
x-logo-theme-adjusted: tile
x-logo-variant: wide
x-logo-lookup: ...
x-cache: HIT
cloudflare-cdn-cache-control: ...
x-cache-age: ...

HTTP durum kodları

  • 200 OK
  • 304 HTTP 304
  • 400 Hatalı İstek
  • 401 Yetkisiz
  • 402 Ödeme Gerekli
  • 403 Yasak
  • 404 Bulunamadı
  • 429 Çok Fazla İstek

Referans kaynakları