Credit API (Verbleibendes Guthaben)

Q: Wie authentifiziere ich mich bei Credit in REST und SOAP?

Für REST senden Sie Ihren TrackServiceKey im Header X-API-Key bei POST /rest/Credit. Für SOAP senden Sie Ihren TrackServiceKey im SessionIDHeader als SessionID bei jedem Aufruf von CreditRemaining.

Q: Was liefert CreditRemaining zurück?

CreditRemaining gibt ein CreditResult zurück, das die Ganzzahl Credit enthält, also Ihr verbleibendes API-Guthaben.

Verwenden Sie Credit, um zu prüfen, wie viel API-Guthaben für Ihren TrackServiceKey noch verfügbar ist. REST liefert CreditResult. SOAP verwendet CreditRemaining.

Prüfen Sie Ihr verbleibendes API-Guthaben mit REST POST /rest/Credit oder SOAP CreditRemaining.

Benötigen Sie den vollständigen Vertrag?

Swagger enthält das REST-Modell (CreditResult) und die Endpunktdetails. SOAP ist über WSDL verfügbar.

Swagger UI ansehen SOAP WSDL ansehen API-Referenz Übersicht

Was Credit macht#

Credit gibt Ihr verbleibendes Guthaben für den aktuellen API-Schlüssel zurück. So können Sie die Nutzung überwachen und Fehler bei Jobs mit hohem Volumen wie Massen-Geokodierung, Batch-Routenberechnung und Dispatch-Optimierung vermeiden.

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

Endpunkte und Basis-URLs#

REST (JSON)

Element	Wert
Basis-URL	https://ts6.trackroad.com
Endpunkt	`POST /rest/Credit`
Vollständige URL	https://ts6.trackroad.com/rest/Credit
Antwortformat	`application/json` (XML wird ebenfalls unterstützt)
Body	Kein Body

SOAP (CreditRemaining)

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

Empfehlung: Verwenden Sie REST, sofern Sie nicht zwingend in ein bestehendes reines SOAP-System integrieren müssen.

Authentifizierung (REST & SOAP)#

REST-Authentifizierung (X-API-Key)

Senden Sie Ihren TrackServiceKey im Header X-API-Key bei jeder REST-Anfrage. Siehe API-Authentifizierung .

SOAP-Authentifizierung (SessionIDHeader)

SOAP-Anfragen verwenden SessionIDHeader. Senden Sie Ihren TrackServiceKey als SessionID bei jedem Aufruf von CreditRemaining.

Anfrageschema#

REST-Anfrage

REST Credit ist eine POST-Anfrage mit keinem Request-Body. Die Authentifizierung erfolgt über den Header X-API-Key.

SOAP-Anfrage

SOAP verwendet die Methode CreditRemaining zusammen mit einem SessionIDHeader.

Antwortschema#

CreditResult (REST + SOAP)

Eigenschaft	Typ	Beschreibung
`Credit`	int	Verbleibendes Guthaben.
`Errors`	Error[]	Fehler oder Warnungen, falls vorhanden.
`Status`	int (enum)	0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Dasselbe Ergebniskonzept wird in REST und SOAP verwendet, sodass sich das verbleibende API-Guthaben in unterschiedlichen Integrations-Stacks einfach überwachen lässt.

Beispiele#

REST-Anfragebeispiele

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

using System.Net.Http;

var url = "https://ts6.trackroad.com/rest/Credit";
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-API-Key", "YOUR_TRACKSERVICEKEY");

var resp = await http.PostAsync(url, null);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://ts6.trackroad.com/rest/Credit";

const res = await fetch(url, {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_TRACKSERVICEKEY"
  }
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    Request request = new Request.Builder()
      .url("https://ts6.trackroad.com/rest/Credit")
      .post(RequestBody.create(new byte[0], null))
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://ts6.trackroad.com/rest/Credit"
headers = {"X-API-Key": "YOUR_TRACKSERVICEKEY"}

r = requests.post(url, headers=headers)
print(r.text)

<?php
$url = "https://ts6.trackroad.com/rest/Credit";

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "X-API-Key: YOUR_TRACKSERVICEKEY"
  ]
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"

uri = URI("https://ts6.trackroad.com/rest/Credit")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri)
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"

res = http.request(req)
puts res.body

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://ts6.trackroad.com/rest/Credit"
  req, _ := http.NewRequest("POST", url, nil)
  req.Header.Set("X-API-Key", "YOUR_TRACKSERVICEKEY")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://ts6.trackroad.com/rest/Credit"
  val client = HttpClient.newHttpClient()

  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .POST(HttpRequest.BodyPublishers.noBody())
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://ts6.trackroad.com/rest/Credit";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_POST, 1L);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://ts6.trackroad.com/rest/Credit";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_POST, 1L);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://ts6.trackroad.com/rest/Credit"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req
      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://ts6.trackroad.com/rest/Credit")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

SOAP-Anfragebeispiele

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

using System.Net.Http;
using System.Text;

var url = "https://ts6.trackroad.com/TrackService.asmx";

var soap = @"<?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:Header>
    <SessionIDHeader xmlns=""http://TrackService.TrackRoad.com/"">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns=""http://TrackService.TrackRoad.com/"" />
  </soap:Body>
</soap:Envelope>";

using var http = new HttpClient();
var content = new StringContent(soap, Encoding.UTF8, "text/xml");
content.Headers.Add("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://ts6.trackroad.com/TrackService.asmx";

const soap = `<?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:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>`;

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "http://TrackService.TrackRoad.com/CreditRemaining"
  },
  body: soap
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    String soap =
      "<?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:Header>"
    + "  <SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    + "   <SessionID>YOUR_TRACKSERVICEKEY</SessionID>"
    + "  </SessionIDHeader>"
    + " </soap:Header>"
    + " <soap:Body>"
    + "  <CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" />"
    + " </soap:Body>"
    + "</soap:Envelope>";

    RequestBody body = RequestBody.create(soap, MediaType.parse("text/xml; charset=utf-8"));
    Request request = new Request.Builder()
      .url("https://ts6.trackroad.com/TrackService.asmx")
      .post(body)
      .addHeader("Content-Type", "text/xml; charset=utf-8")
      .addHeader("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://ts6.trackroad.com/TrackService.asmx"
soap = """<?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:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
"""

headers = {
  "Content-Type": "text/xml; charset=utf-8",
  "SOAPAction": "http://TrackService.TrackRoad.com/CreditRemaining"
}

r = requests.post(url, data=soap.encode("utf-8"), headers=headers)
print(r.text)

<?php
$url = "https://ts6.trackroad.com/TrackService.asmx";
$soap = <<<XML
<?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:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
XML;

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: text/xml; charset=utf-8",
    "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining"
  ],
  CURLOPT_POSTFIELDS => $soap
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"

uri = URI("https://ts6.trackroad.com/TrackService.asmx")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

soap = <<~XML
<?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:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
XML

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "http://TrackService.TrackRoad.com/CreditRemaining"
req.body = soap

res = http.request(req)
puts res.body

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://ts6.trackroad.com/TrackService.asmx"
  soap := []byte(`<?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:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(soap))
  req.Header.Set("Content-Type", "text/xml; charset=utf-8")
  req.Header.Set("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://ts6.trackroad.com/TrackService.asmx"
  val soap = """
    <?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:Header>
        <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
          <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
        </SessionIDHeader>
      </soap:Header>
      <soap:Body>
        <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
      </soap:Body>
    </soap:Envelope>
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining")
    .POST(HttpRequest.BodyPublishers.ofString(soap))
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://ts6.trackroad.com/TrackService.asmx";
  const char *soap =
    "<?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:Header><SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    "<SessionID>YOUR_TRACKSERVICEKEY</SessionID></SessionIDHeader></soap:Header>"
    "<soap:Body><CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" /></soap:Body>"
    "</soap:Envelope>";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, soap);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://ts6.trackroad.com/TrackService.asmx";
  std::string soap =
    "<?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:Header><SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    "<SessionID>YOUR_TRACKSERVICEKEY</SessionID></SessionIDHeader></soap:Header>"
    "<soap:Body><CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" /></soap:Body>"
    "</soap:Envelope>";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, soap.c_str());

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://ts6.trackroad.com/TrackService.asmx"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"text/xml; charset=utf-8" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"http://TrackService.TrackRoad.com/CreditRemaining" forHTTPHeaderField:@"SOAPAction"];

    NSString *soap =
      @"<?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:Header><SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\"><SessionID>YOUR_TRACKSERVICEKEY</SessionID></SessionIDHeader></soap:Header>"
       "<soap:Body><CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" /></soap:Body>"
       "</soap:Envelope>";

    [req setHTTPBody:[soap dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://ts6.trackroad.com/TrackService.asmx")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("text/xml; charset=utf-8", forHTTPHeaderField: "Content-Type")
req.setValue("http://TrackService.TrackRoad.com/CreditRemaining", forHTTPHeaderField: "SOAPAction")

let soap = """
<?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:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
"""
req.httpBody = soap.data(using: .utf8)

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

Antwortbeispiele

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>

Häufige Fehler#

REST 401 / Unauthorized: Fehlender oder ungültiger X-API-Key.
REST 403 / Forbidden: Der Schlüssel ist gültig, aber gesperrt, abgelaufen oder ohne Guthaben.
Status = 2 (Failed): Prüfen Sie Errors[] auf die Ursache.
SOAP-Authentifizierungsfehler: Fehlender oder ungültiger SessionIDHeader (SessionID muss Ihr TrackServiceKey sein).

Best Practices#

Überwachen Sie das Guthaben in Produktion und lösen Sie einen Alarm aus, wenn es unter Ihren sicheren Schwellenwert fällt.
Prüfen Sie das Guthaben vor Batch-Jobs wie Geokodierung, Routing oder Dispatching im großen Maßstab.
Speichern Sie Schlüssel serverseitig und rotieren Sie sie, wenn sie kompromittiert wurden.
Bevorzugen Sie REST, sofern keine reine SOAP-Integration erforderlich ist.

FAQ#

Was macht die Credit API?

Die Credit API gibt zurück, wie viel API-Guthaben für Ihren TrackServiceKey noch verfügbar ist.

Wie authentifiziere ich mich bei Credit in REST und SOAP?

Für REST senden Sie Ihren TrackServiceKey im Header X-API-Key bei POST /rest/Credit. Für SOAP senden Sie Ihren TrackServiceKey im SessionIDHeader als SessionID bei jedem Aufruf von CreditRemaining.

Was liefert CreditRemaining zurück?

CreditRemaining gibt ein CreditResult zurück, das die Ganzzahl Credit enthält, also Ihr verbleibendes API-Guthaben.

Wann sollte ich mein verbleibendes API-Guthaben prüfen?

Prüfen Sie Ihr verbleibendes API-Guthaben vor Massen-Geokodierung, Routenoptimierung oder Dispatch-Jobs und überwachen Sie es in Produktion, um Unterbrechungen zu vermeiden.

Nächster Schritt: Routen berechnen

Nachdem Sie das verbleibende Guthaben bestätigt haben, fahren Sie mit Routes oder Dispatch fort, um Lieferungen und Flottenabläufe zu optimieren.

Zu Routes Zu Dispatch