API Credit (Crédit restant)

Q: À quoi sert l’API Credit ?

L’API Credit renvoie le crédit API restant pour votre TrackServiceKey.

Q: Comment m’authentifier à Credit en REST et en SOAP ?

Pour REST, envoyez votre TrackServiceKey dans l’en-tête X-API-Key avec POST /rest/Credit. Pour SOAP, envoyez votre TrackServiceKey dans SessionIDHeader comme SessionID à chaque appel CreditRemaining.

Q: Que renvoie CreditRemaining ?

CreditRemaining renvoie un CreditResult qui inclut l’entier Credit, c’est-à-dire votre solde de crédit API restant.

Utilisez Credit pour vérifier combien de crédit API il reste pour votre TrackServiceKey. REST renvoie CreditResult. SOAP utilise CreditRemaining.

Vérifiez votre crédit API restant avec REST POST /rest/Credit ou SOAP CreditRemaining.

Besoin du contrat complet ?

Swagger inclut le modèle REST (CreditResult) et les détails du point de terminaison. SOAP est disponible via WSDL.

Voir Swagger UI Voir SOAP WSDL Vue d’ensemble de la référence API

À quoi sert Credit#

Credit renvoie votre solde restant pour la clé API actuelle. Cela vous aide à surveiller l’utilisation et à éviter les échecs lors de traitements volumineux comme le géocodage en masse, la génération de tournées par lot et l’optimisation de dispatch.

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

Endpoints et URL de base#

REST (JSON)

Élément	Valeur
URL de base	https://ts6.trackroad.com
Endpoint	`POST /rest/Credit`
URL complète	https://ts6.trackroad.com/rest/Credit
Produit	`application/json` (XML est également pris en charge)
Corps	Aucun corps

SOAP (CreditRemaining)

Élément	Valeur
URL SOAP	https://ts6.trackroad.com/TrackService.asmx
WSDL	https://ts6.trackroad.com/TrackService.asmx?WSDL
Méthode	`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`

Recommandé : utilisez REST sauf si vous devez vous intégrer à un système existant uniquement compatible SOAP.

Authentification (REST et SOAP)#

Authentification REST (X-API-Key)

Envoyez votre TrackServiceKey dans l’en-tête X-API-Key pour chaque requête REST. Voir Authentification API .

Authentification SOAP (SessionIDHeader)

Les requêtes SOAP utilisent SessionIDHeader. Envoyez votre TrackServiceKey comme SessionID à chaque appel CreditRemaining.

Schéma de requête#

Requête REST

REST Credit est une requête POST sans corps de requête. L’authentification se fait via l’en-tête X-API-Key.

Requête SOAP

SOAP utilise la méthode CreditRemaining avec un SessionIDHeader.

Schéma de réponse#

CreditResult (REST + SOAP)

Propriété	Type	Description
`Credit`	int	Solde de crédit restant.
`Errors`	Error[]	Erreurs ou avertissements, le cas échéant.
`Status`	int (enum)	0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Le même concept de résultat est utilisé en REST et en SOAP, ce qui facilite la surveillance du crédit API restant dans différents environnements d’intégration.

Exemples#

Exemples de requêtes 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()

Exemples de requêtes 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()

Exemples de réponse

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>

Erreurs courantes#

REST 401 / Unauthorized : X-API-Key manquant ou invalide.
REST 403 / Forbidden : la clé est valide mais bloquée, expirée ou sans crédit.
Status = 2 (Failed) : consultez Errors[] pour connaître la raison.
Échec d’authentification SOAP : SessionIDHeader manquant ou invalide (SessionID doit être votre TrackServiceKey).

Bonnes pratiques#

Surveillez le crédit en production et déclenchez une alerte lorsqu’il passe sous votre seuil de sécurité.
Vérifiez le crédit avant les traitements par lot comme le géocodage, le routing ou le dispatch à grande échelle.
Conservez les clés côté serveur et faites-les tourner si elles sont compromises.
Privilégiez REST sauf si vous avez une exigence d’intégration uniquement SOAP.

FAQ#

À quoi sert l’API Credit ?

L’API Credit renvoie le crédit API restant pour votre TrackServiceKey.

Comment m’authentifier à Credit en REST et en SOAP ?

Pour REST, envoyez votre TrackServiceKey dans l’en-tête X-API-Key avec POST /rest/Credit. Pour SOAP, envoyez votre TrackServiceKey dans SessionIDHeader comme SessionID à chaque appel CreditRemaining.

Que renvoie CreditRemaining ?

CreditRemaining renvoie un CreditResult qui inclut l’entier Credit, c’est-à-dire votre solde de crédit API restant.

Quand dois-je vérifier mon crédit API restant ?

Vérifiez votre crédit API restant avant d’exécuter des traitements massifs de géocodage, d’optimisation de tournées ou de dispatch, et surveillez-le en production afin d’éviter les interruptions.

Étape suivante : calculer des tournées

Après avoir confirmé votre crédit restant, continuez avec Routes ou Dispatch pour optimiser les livraisons et les opérations de flotte.

Aller à Routes Aller à Dispatch