Referencja API

API API obrazów logo

Pobierz logo firmy dla dowolnej domeny jako obraz PNG, który możesz osadzać, zapisywać w pamięci podręcznej i zachować. Skorzystaj z tej dokumentacji, aby wybrać odpowiedni endpoint i dokładnie zobaczyć, co zwraca.

Operacje

GET /v1/logo/:domain Otwórz referencję API

GET /v1/logo/:domain

Operacja: getLogoImage Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
GET /v1/logo/:domain Kredyty: 1

Parametry zapytania

Parametr Typ wymagane
domain string wymagane
size integer
Domyślnie 128
opcjonalne
retina boolean
Domyślnie false
opcjonalne
greyscale boolean
Domyślnie false
opcjonalne
theme string
Dozwolone wartości lightdark
opcjonalne
fallback string
Dozwolone wartości 404monogram
Domyślnie 404
opcjonalne
format string
Dozwolone wartości png
Domyślnie png
opcjonalne
variant string
Dozwolone wartości squarewide
Domyślnie square
opcjonalne
v string opcjonalne
token string opcjonalne

Pola odpowiedzi

Pole Typ
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

Przykładowe żądanie

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))

Przykładowa odpowiedź

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: ...

Kody statusu HTTP

  • 200 OK
  • 304 HTTP 304
  • 400 Nieprawidłowe żądanie
  • 401 Nieautoryzowany
  • 402 Wymagana płatność
  • 403 Zabronione
  • 404 Nie znaleziono
  • 429 Zbyt wiele żądań

Materiały referencyjne