API Credit (Pozostały kredyt)

Q: Jak uwierzytelnić się w Credit przez REST i SOAP?

Dla REST wyślij swój TrackServiceKey w nagłówku X-API-Key przy POST /rest/Credit. Dla SOAP wyślij swój TrackServiceKey w SessionIDHeader jako SessionID przy każdym wywołaniu CreditRemaining.

Q: Co zwraca CreditRemaining?

CreditRemaining zwraca CreditResult, który zawiera liczbę całkowitą Credit, czyli pozostałe saldo kredytu API.

Użyj Credit, aby sprawdzić, ile kredytu API pozostało dla Twojego TrackServiceKey. REST zwraca CreditResult. SOAP używa CreditRemaining.

Sprawdź pozostały kredyt API za pomocą REST POST /rest/Credit lub SOAP CreditRemaining.

Potrzebujesz pełnej specyfikacji?

Swagger zawiera model REST (CreditResult) oraz szczegóły endpointu. SOAP jest dostępny przez WSDL.

Otwórz Swagger UI Otwórz SOAP WSDL Przegląd dokumentacji API

Co robi Credit#

Credit zwraca pozostałe saldo dla bieżącego klucza API. Pomaga monitorować zużycie i unikać błędów w zadaniach o dużej skali, takich jak masowe geokodowanie, wsadowe wyznaczanie tras i optymalizacja dispatch.

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

Endpointy i bazowe adresy URL#

REST (JSON)

Element	Wartość
Adres bazowy	https://ts6.trackroad.com
Endpoint	`POST /rest/Credit`
Pełny adres URL	https://ts6.trackroad.com/rest/Credit
Zwraca	`application/json` (obsługiwany jest również XML)
Body	Brak body

SOAP (CreditRemaining)

Element	Wartość
Adres SOAP	https://ts6.trackroad.com/TrackService.asmx
WSDL	https://ts6.trackroad.com/TrackService.asmx?WSDL
Metoda	`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`

Zalecane: używaj REST, chyba że musisz integrować się z istniejącym systemem obsługującym wyłącznie SOAP.

Uwierzytelnianie (REST i SOAP)#

Uwierzytelnianie REST (X-API-Key)

Wysyłaj swój TrackServiceKey w nagłówku X-API-Key przy każdym żądaniu REST. Zobacz Uwierzytelnianie API .

Uwierzytelnianie SOAP (SessionIDHeader)

Żądania SOAP używają SessionIDHeader. Wysyłaj swój TrackServiceKey jako SessionID przy każdym wywołaniu CreditRemaining.

Login/Logout może pozostać udokumentowany jako starszy mechanizm, ale klucz API jest zalecaną metodą uwierzytelniania.

Schemat żądania#

Żądanie REST

REST Credit to żądanie POST bez treści żądania. Uwierzytelnianie odbywa się przez nagłówek X-API-Key.

Żądanie SOAP

SOAP używa metody CreditRemaining wraz z SessionIDHeader.

Schemat odpowiedzi#

CreditResult (REST + SOAP)

Właściwość	Typ	Opis
`Credit`	int	Pozostałe saldo kredytu.
`Errors`	Error[]	Błędy lub ostrzeżenia, jeśli występują.
`Status`	int (enum)	0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Ta sama koncepcja wyniku jest używana zarówno w REST, jak i w SOAP, co ułatwia monitorowanie pozostałego kredytu API w różnych środowiskach integracyjnych.

Przykłady#

Przykłady żądań REST

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()

Przykłady żądań 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

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()

Przykłady odpowiedzi

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>

Typowe błędy#

REST 401 / Unauthorized: brak nagłówka X-API-Key lub jest on nieprawidłowy.
REST 403 / Forbidden: klucz jest poprawny, ale zablokowany, wygasły lub bez kredytu.
Status = 2 (Failed): sprawdź Errors[], aby poznać przyczynę.
Błąd uwierzytelniania SOAP: brak lub nieprawidłowy SessionIDHeader (SessionID musi być Twoim TrackServiceKey).

Dobre praktyki#

Monitoruj kredyt w produkcji i ustaw alert, gdy spadnie poniżej bezpiecznego progu.
Sprawdzaj kredyt przed zadaniami wsadowymi, takimi jak geokodowanie, routing lub dispatch na dużą skalę.
Przechowuj klucze po stronie serwera i rotuj je, jeśli zostaną ujawnione.
Wybieraj REST, chyba że masz wymaganie integracji wyłącznie przez SOAP.

FAQ#

Co robi API Credit?

API Credit zwraca informację, ile kredytu API pozostało dla Twojego TrackServiceKey.

Jak uwierzytelnić się w Credit przez REST i SOAP?

Dla REST wyślij swój TrackServiceKey w nagłówku X-API-Key przy POST /rest/Credit. Dla SOAP wyślij swój TrackServiceKey w SessionIDHeader jako SessionID przy każdym wywołaniu CreditRemaining.

Co zwraca CreditRemaining?

CreditRemaining zwraca CreditResult, który zawiera liczbę całkowitą Credit, czyli pozostałe saldo kredytu API.

Kiedy powinienem sprawdzać pozostały kredyt API?

Sprawdzaj pozostały kredyt API przed uruchamianiem masowych zadań geokodowania, optymalizacji tras lub dispatch, a także monitoruj go w produkcji, aby uniknąć przerw.

Następny krok: oblicz trasy

Po potwierdzeniu pozostałego kredytu przejdź do Routes lub Dispatch, aby zoptymalizować dostawy i operacje floty.

Przejdź do Routes Przejdź do Dispatch