Saltar al contenido principal
GET
/
v1
/
maps
/
{map_id}
Karte abrufen
curl --request GET \
  --url https://api.olostep.com/v1/maps/{map_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "urls_count": 123,
  "urls": [
    "<string>"
  ],
  "cursor": "<string>"
}

​
Descripción

Este endpoint recupera los detalles de un mapa específico utilizando su map_id. Es útil para obtener información sobre un mapa existente en la plataforma Olostep.

​
Solicitud

​
Parámetros de Ruta

  • map_id: Identificador único del mapa que deseas recuperar. Este es un parámetro obligatorio.

​
Ejemplo de Solicitud

GET /v1/maps/12345

​
Respuesta

Una respuesta exitosa devolverá un objeto JSON que contiene los detalles del mapa solicitado.

​
Ejemplo de Respuesta

{
  "id": "12345",
  "name": "Mapa de ejemplo",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T12:00:00Z",
  "layers": [
    {
      "id": "layer1",
      "name": "Capa de ejemplo"
    }
  ]
}

​
Errores

  • 404 Not Found: Si no se encuentra un mapa con el map_id proporcionado.
  • 401 Unauthorized: Si no tienes permiso para acceder a este recurso.

​
Notas

Asegúrate de que el map_id que proporcionas es correcto y que tienes los permisos necesarios para acceder al mapa.

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
map_id
string
requerido

Eindeutiger Bezeichner für die abzurufende Karte.

Respuesta

Erfolgreiche Antwort mit dem Kartenobjekt.

​
id
string

Eindeutiger Bezeichner für diese Karte

​
urls_count
integer

Anzahl der URLs in der aktuellen Antwort

​
urls
string[]

Array von URLs, die auf der Seite gefunden wurden

​
cursor
string | null

Paginierungscursor, um den nächsten Satz von URLs abzurufen. Wenn null, wurden alle URLs abgerufen.