Vai al contenuto principale
GET
/
v1
/
maps
/
{map_id}
Ottieni Mappa
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>"
}

Ottieni Mappa

Questa API ti permette di recuperare i dettagli di una mappa specifica utilizzando il suo map_id.

Richiesta HTTP

GET /v1/maps/{map_id}

Parametri

NomeTipoDescrizione
map_idstringL’identificatore univoco della mappa.

Risposta

Una risposta di successo restituirà i dettagli della mappa richiesta.

Esempio di risposta

{
  "id": "12345",
  "name": "Mappa di esempio",
  "description": "Questa è una mappa di esempio.",
  "created_at": "2023-01-01T12:00:00Z"
}

Errori

CodiceMessaggioDescrizione
404Mappa non trovataLa mappa con l’ID specificato non esiste.
401Non autorizzatoNon hai i permessi per accedere a questa risorsa.

Esempio di utilizzo

Ecco un esempio di come puoi utilizzare questa API con curl:
curl -X GET "https://api.olostep.com/v1/maps/12345" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Assicurati di sostituire YOUR_ACCESS_TOKEN con il tuo token di accesso effettivo.

Autorizzazioni

Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer della forma Bearer , dove è il tuo token di autenticazione.

Parametri del percorso

map_id
string
obbligatorio

Identificatore univoco per la mappa da recuperare.

Risposta

Risposta positiva con l'oggetto mappa.

id
string

Identificatore univoco per questa mappa

urls_count
integer

Numero di URL nella risposta corrente

urls
string[]

Array di URL trovati sulla pagina

cursor
string | null

Cursore di paginazione per recuperare il prossimo set di URL. Se nullo, tutti gli URL sono stati recuperati.