Passer au contenu principal
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"
  ]
}

Autorisations

​
Authorization
string
header
requis

En-tête d'authentification Bearer sous la forme Bearer , où est ton jeton d'authentification.

Corps

application/json
​
url
string<uri>
requis

L'URL du site web pour lequel tu veux les liens

​
search_query
string

Une requête de recherche optionnelle pour trier les liens par pertinence de recherche.

​
top_n
number

Un nombre optionnel pour limiter aux n premiers liens pour une requête de recherche.

​
include_subdomain
boolean

Inclure les sous-domaines de l'URL donnée. true par défaut.

​
include_urls
string[]

Modèles de chemin d'URL à inclure en utilisant la syntaxe glob. Par exemple : /blog/** pour inclure uniquement les URLs de blog. Seules les URLs correspondant à ces modèles seront retournées.

​
exclude_urls
string[]

Modèles de chemin d'URL à exclure en utilisant la syntaxe glob. Par exemple : /careers/**. Les URLs exclues supplanteront les URLs incluses.

​
cursor
string

OPTIONNEL : Curseur de pagination d'une réponse précédente. Lorsqu'il est fourni, retourne le prochain ensemble d'URLs à partir de l'endroit où la demande précédente s'est arrêtée en raison de la limite de taille de réponse.

Réponse

Réponse réussie avec les URLs trouvées sur la page

​
urls_count
integer
requis

Nombre d'URLs dans la réponse actuelle

​
urls
string[]
requis

Tableau d'URLs trouvées sur la page

​
id
string

Identifiant unique pour cette carte

​
cursor
string

Curseur de pagination pour récupérer le prochain ensemble d'URLs limité en raison de la limite de taille de 10MB. Si null ou non présent, toutes les URLs ont été récupérées.