API Credit (Credito residuo)

Usa Credit per verificare quanto credito API rimane per il tuo TrackServiceKey. REST restituisce CreditResult. SOAP usa CreditRemaining.

API Credit di TrackRoad che mostra il credito API residuo tramite REST /rest/Credit e SOAP CreditRemaining.
Controlla il tuo credito API residuo usando REST POST /rest/Credit o SOAP CreditRemaining.

Hai bisogno del contratto completo?

Swagger include il modello REST (CreditResult) e i dettagli dell'endpoint. SOAP è disponibile tramite WSDL.

Apri Swagger UI Apri SOAP WSDL Panoramica riferimento API

Indice dei contenuti

  1. Cosa fa Credit
  2. Endpoint e URL di base
  3. Autenticazione (REST e SOAP)
  4. Schema della richiesta
  5. Schema della risposta
  6. Esempi
  7. Errori comuni
  8. Best practice
  9. Endpoint correlati
  10. FAQ

Cosa fa Credit#

Credit restituisce il saldo residuo per la chiave API corrente. Ti aiuta a monitorare l'utilizzo ed evitare errori in processi ad alto volume come geocodifica massiva, generazione batch di percorsi e ottimizzazione dispatch.

REST: POST /rest/Credit. SOAP: CreditRemaining.

Endpoint e URL di base#

REST (JSON)

Elemento Valore
URL di base https://ts6.trackroad.com
Endpoint POST /rest/Credit
URL completo https://ts6.trackroad.com/rest/Credit
Restituisce application/json (è supportato anche XML)
Body Nessun body

SOAP (CreditRemaining)

Elemento Valore
URL SOAP https://ts6.trackroad.com/TrackService.asmx
WSDL https://ts6.trackroad.com/TrackService.asmx?WSDL
Metodo CreditRemaining
SOAPAction http://TrackService.TrackRoad.com/CreditRemaining
Content-Type SOAP 1.1 text/xml; charset=utf-8
Content-Type SOAP 1.2 application/soap+xml; charset=utf-8

Consigliato: usa REST, a meno che tu non debba integrarti con un sistema esistente solo SOAP.

Autenticazione (REST e SOAP)#

Autenticazione REST (X-API-Key)

Invia il tuo TrackServiceKey nell'header X-API-Key in ogni richiesta REST. Vedi Autenticazione API .

Autenticazione SOAP (SessionIDHeader)

Le richieste SOAP usano SessionIDHeader. Invia il tuo TrackServiceKey come SessionID per ogni chiamata a CreditRemaining.

Login/Logout può rimanere documentato come legacy, ma la chiave API è il metodo di autenticazione consigliato.

Schema della richiesta#

Richiesta REST

REST Credit è una richiesta POST senza body della richiesta. L'autenticazione avviene tramite l'header X-API-Key.

Richiesta SOAP

SOAP usa il metodo CreditRemaining con un SessionIDHeader.

Schema della risposta#

CreditResult (REST + SOAP)

Proprietà Tipo Descrizione
Credit int Saldo credito residuo.
Errors Error[] Errori o avvisi, se presenti.
Status int (enum) 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Lo stesso concetto di risultato è usato sia in REST sia in SOAP, rendendo semplice monitorare il credito API residuo in diversi stack di integrazione.

Esempi#

Esempi di richieste REST

curl -X POST "https://ts6.trackroad.com/rest/Credit" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY"

Esempi di richieste SOAP

curl -X POST "https://ts6.trackroad.com/TrackService.asmx" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining" \
  -d @creditRemaining.xml

Esempi di risposta

REST JSON response example (shape)#

{
  "Credit": 12345,
  "Errors": [],
  "Status": 1
}

SOAP response example (SOAP 1.1)#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreditRemainingResponse xmlns="http://TrackService.TrackRoad.com/">
      <CreditRemainingResult>
        <Credit>12345</Credit>
      </CreditRemainingResult>
    </CreditRemainingResponse>
  </soap:Body>
</soap:Envelope>

Errori comuni#

  • REST 401 / Unauthorized: X-API-Key mancante o non valido.
  • REST 403 / Forbidden: la chiave è valida ma bloccata, scaduta o senza credito.
  • Status = 2 (Failed): controlla Errors[] per la causa.
  • Errore di autenticazione SOAP: SessionIDHeader mancante o non valido (SessionID deve essere il tuo TrackServiceKey).

Best practice#

  • Monitora il credito in produzione e imposta avvisi quando scende sotto la soglia di sicurezza.
  • Controlla il credito prima dei processi batch come geocoding, routing o dispatch su larga scala.
  • Conserva le chiavi lato server e ruotale se vengono compromesse.
  • Preferisci REST, salvo esigenze di integrazione solo SOAP.

FAQ#

Cosa fa l'API Credit?
L'API Credit restituisce quanto credito API rimane per il tuo TrackServiceKey.
Come faccio l'autenticazione a Credit con REST e SOAP?
Per REST, invia il tuo TrackServiceKey nell'header X-API-Key su POST /rest/Credit. Per SOAP, invia il tuo TrackServiceKey in SessionIDHeader come SessionID per ogni chiamata a CreditRemaining.
Cosa restituisce CreditRemaining?
CreditRemaining restituisce un CreditResult che include l'intero Credit, cioè il tuo saldo API residuo.
Quando dovrei controllare il credito API residuo?
Controlla il credito API residuo prima di eseguire processi massivi di geocodifica, ottimizzazione dei percorsi o dispatch, e monitoralo in produzione per evitare interruzioni.

Passo successivo: calcolare i percorsi

Dopo aver confermato il credito residuo, continua con Routes o Dispatch per ottimizzare consegne e operazioni di flotta.

Vai a Routes Vai a Dispatch