跳转到主要内容
POST
/
v1
/
maps
curl --request POST \
  --url https://api.olostep.com/v1/maps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://docs.olostep.com"
}
'
{
  "id": "map_abc123",
  "urls_count": 22,
  "urls": [
    "https://docs.olostep.com/api-reference/batches/create",
    "https://docs.olostep.com/api-reference/batches/info",
    "https://docs.olostep.com/api-reference/batches/items"
  ]
}

授权

​
Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
​
url
string<uri>
必填

Die URL der Website, für die Sie die Links möchten

​
search_query
string

Eine optionale Suchanfrage, um die Links nach Suchrelevanz zu sortieren.

​
top_n
number

Eine optionale Zahl, um die Suche auf nur die obersten n Links zu beschränken.

​
include_subdomain
boolean

Subdomains der angegebenen URL einbeziehen. Standardmäßig true.

​
include_urls
string[]

URL-Pfadmuster, die mit Glob-Syntax einzuschließen sind. Zum Beispiel: /blog/**, um nur Blog-URLs einzuschließen. Es werden nur URLs zurückgegeben, die diesen Mustern entsprechen.

​
exclude_urls
string[]

URL-Pfadmuster, die mit Glob-Syntax auszuschließen sind. Zum Beispiel: /careers/**. Ausgeschlossene URLs haben Vorrang vor eingeschlossenen URLs.

​
cursor
string

OPTIONAL: Paginierungscursor aus einer vorherigen Antwort. Wenn angegeben, werden die nächsten URLs abgerufen, wo die vorherige Anfrage aufgrund der Größenbeschränkung der Antwort aufgehört hat.

响应

Erfolgreiche Antwort mit URLs, die auf der Seite gefunden wurden

​
urls_count
integer
必填

Anzahl der URLs in der aktuellen Antwort

​
urls
string[]
必填

Array von URLs, die auf der Seite gefunden wurden

​
id
string

Eindeutiger Bezeichner für diese Karte

​
cursor
string

Paginierungscursor, um den nächsten Satz von URLs abzurufen, der aufgrund des 10MB Größenlimits begrenzt ist. Wenn null oder nicht vorhanden, wurden alle URLs abgerufen.