Sidebar

Überblick

So gehen Sie die ersten Schritte in der TI Store API Suite: 

  1. Voraussetzungen für Zugang und Entwicklung. 
  2. Machen Sie sich mit dem typischen Bestellablauf mit der TI store-API-Suite vertraut.
  3. Authentifizieren Sie sich, um ein Zugriffstoken zu erhalten.
  4. Erfahren Sie, wie Sie Bestands- und Preisinformationen abfragen können.
  5. Erstellen Sie eine Testbestellung.
  6. Greifen Sie auf Ihre Bestellinformationen zu.
  7. Erfahren Sie, wie Sie die Sendungsverfolgung abrufen können.
  8. Erfahren Sie, wie Sie eine Rechnung abrufen können.
  9. Erhalten Sie Unterstützung.

 

Schritt 1: Voraussetzungen

 

Nur zugelassene Kunden können Anwendungen mit der TI Store API Suite erstellen. Um eine Genehmigung zu erhalten:

  1. Legen Sie ein myTI-Konto an, oder melden Sie sich bei Ihrem bestehenden myTI-Konto an.
  2. Erstellen Sie ein myTI-Firmenkonto.
  3. Klicken Sie auf der Seite API-Schlüssel und Zugriff auf die Schaltfläche „Anfordern“.

 

Schritt 2: Übersicht über den Bestellablauf

 

  1. Authentifizieren Sie sich mit dem Ihnen zugewiesenen API-Schlüssel und -Kennwort.
  2. Senden Sie eine Abfrage an die Inventar- und Preis-API, um Produktverfügbarkeit und andere zugehörige Informationen abzurufen. 
  3. Die API antwortet mit dem Statuscode 200 OK und einer JSON-Antwort (JavaScript Object Notation), die die angeforderten Produktdaten enthält.
  4. Erstellen Sie Ihren Auftrag mit dem gewünschten Payload, und senden Sie ihn an die Bestell-API.
  5. Die API antwortet mit dem Statuscode 200 OK und einer JSON-Datei, die die Auftragsbestätigung enthält.
  6. Fragen Sie die Bestell-API nach dem Auftragsstatus und zusätzlichen Auftragsdetails.
  7. Nach der Auftragsabwicklung können Sie die Sendungsverfolgung über die ASN-API (Advanced Ship Notice)-Abfrage-API und Rechnungen über die Finanzdokumente-API abrufen.
  8. Möchten Sie Beispielcode für jeden dieser Schritte sehen? Laden Sie unseren Beispielcode herunter.

 

 

Schritt 3: Authentifizieren

 

TI hat seine API-Suiten mit OAuth 2.0 gesichert. Verwenden Sie für die Authentifizierung Ihren API-Schlüssel und Ihr API-Kennwort. Nach der Autorisierung gibt OAuth2 einen Zugriffstoken zurück, der mit APIs in der von Ihnen aktivierten Suite verwendet wird. Weitere Details finden Sie auf der Seite Authentifizierung.  

curl --request POST \   
       --url https://transact.ti.com/v1/oauth/accesstoken \   
       --header 'Content-Type: application/x-www-form-urlencoded' \   
       --data grant_type=client_credentials \   
       --data client_id=<<INSERT YOUR CLIENT KEY>> \   
       --data client_secret=<<INSERT YOUR SECRET>>

 

Schritt 4: Abfragen von Beständen und Preisen

 

Das folgende Beispiel veranschaulicht, wie Sie Lagerverfügbarkeits- und Preisinformationen je Produkt abrufen können, indem Sie die Teilenummer AFE7799IABJ abfragen. Der verfügbare Bestand beträgt 5.435 („Menge“: 5435); in diesem Beispiel ist die Menge jedoch auf einen Grenzwert von 50 („Grenzwert“: 50) Einheiten pro Bestellung beschränkt. Wenn das Produkt kein Bestelllimit hat, gibt die JSON-Antwort einen leeren Wert im Grenzwertfeld zurück. Eine Liste aller Parameter, die sich auf Produkte beziehen, finden Sie in der Dokumentation zur Bestands- und Preis-API.

Beispiel für eine Anforderung: 

curl --request GET \   
--url 'https://transact.ti.com/v2/store/products/AFE7799IABJ?currency=USD' \
--header 'Authorization: Bearer {access_token}' \

Antwort auf eine erfolgreiche Anfrage:

{
  "tiPartNumber": "AFE7799IABJ",
  "genericPartNumber": "AFE7799",
  "buyNowURL": "https://www.ti.com/product/AFE7799/part-details/AFE7799IABJ",
  "quantity": 5435,
  "limit": 50,
  "pricing": [
    {
      "currency": "USD",
      "priceBreaks": [
        {
          "priceBreakQuantity": 1,
          "price": 2.03
        },
        {
          "priceBreakQuantity": 10,
          "price": 1.43
        },
        {
          "priceBreakQuantity": 25,
          "price": 1.35
        },

...

  ],
  "description": "8-Bit 200MSPS Low-Power Analog-to-Digital Converter (ADC) With Internal Sample and Hold",
  "minimumOrderQuantity": 1,
  "standardPackQuantity": 126,
  "exportControlClassificationNumber": "EAR99",
  "htsCode": "8542390001",
  "pinCount": 5,
  "packageType": "SOT-23 (DBV)",
  "packageCarrier": "Large T&R",
  "customReel": true,
  "lifeCycle": "ACTIVE"
}

 

Schritt 5: Erstellen Sie eine Testbestellung

 

Testbestellungen sind simuliert, es handelt sich also nicht um eingereichte Bestellungen. Sie sollen lediglich die Entwicklung Ihrer Bewerbung unterstützen. Der Lagerbestand, der für den Auftrag von Testbestellungen verwendet wird, wird nicht vermindert oder zurückgestellt. Die zurückgegebenen Informationen entsprechen den Informationen, die von den Produktionsbestelldaten zurückgegeben werden. Einige Felder dienen allerdings nur zur Veranschaulichung und stellen keine verarbeiteten Informationen dar.

Um eine Bestellung aufgeben zu können (Test oder Produktion), müssen Sie ein API-fähiges Checkout-Profil in Ihrem Firmenkonto gespeichert haben. Auf der Seite API-Schlüssel und Zugriff erfahren Sie mehr über die Erstellung von Unternehmenskonten und Checkout-Profilen Um ein Checkout-Profil auszuwählen, auf das Sie sich bei Ihrer Bestellung beziehen, müssen Sie die Checkout-Profil-ID aus Ihrem Firmenkonto abrufen. Sie finden die Checkout-Profile in Ihrem myTI-Dashboard unter „Bestelleinstellungen“ > „Checkout-Profile“. Wie unten dargestellt, suchen Sie auf der Checkout-Profil-Seite nach dem Kopiersymbol in der Spalte ID neben dem Checkout-Profil, das Sie verwenden möchten.

 

Checkout profiles table with ID column highlighted

Kopieren Sie die ID, die Sie für Ihre Bestellung verwenden möchten.

  "Orders" : {
    "checkoutProfileID" : "INSERT YOUR CHECKOUTPROFILEID HERE",
    "customerPurchaseOrderNumber" : "PGR - 04202021",
    "purchaseOrderDate" : "2020-12-31T13:56:00Z",
    "endCustomerCompanyName" : "TI Electronics Inc",
    "expediteShipping" : true,

Verwenden Sie Ihre generierte checkoutProfileID und GEBEN Sie Ihre Bestellung AUF.

#!/bin/bash
curl --request POST \
--url 'https://transact.ti.com/v2/store/orders/test' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA
{
  "Orders" : {
    "checkoutProfileId" : "COP_ID-1234",
    "customerPurchaseOrderNumber" : "PGR - 04202021",
    "purchaseOrderDate" : "2020-12-31T13:56:00Z",
    "endCustomerCompanyName" : "TI Electronics Inc",
    "expediteShipping" : true,
    "orderComments" : [ {
      "attribute" : "PO: 234723"
    }, {
      "attribute" : "my Test order"
    } ],
    "lineItems" : [ {
      "customerLineItemNumber" : 1,
      "tiPartNumber" : "ISO1042",
      "customerPartNumber" : "CUS-SN74LS00N",
      "customReelIndicator" : false,
      "quantity" : 10000,
      "customerItemAttributes" : [ {
        "attribute" : "For BOM2  - aquired "
      } ]
    }, {
      "customerLineItemNumber" : 2,
      "tiPartNumber" : "OPA33AIDR",
      "quantity" : 10000
    } ]
  }
}
DATA

Beispielantwort:

{
  "orderNumber": 0,
  "orderStatus": "string",
  "customerPurchaseOrderNumber": "string",
  "subTotal": 0,
  "totalPrice": 0,
  "lineItems": [
    {
      "tiPartNumber": "string",
      "tiPartDescription": "string",
      "quantity": "string",
      "status": "string",
      "unitPrice": 0,
      "customReelIndicator": true
    }
  ],
  "shippingAddress": [
    {
      "addressType": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "town": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "email": "string",
      "phoneNumber": "string",
      "companyURL": "string"
    }
  ],
  "billingAddress": [
    {
      "addressType": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "town": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "email": "string",
      "phoneNumber": "string",
      "companyURL": "string"
    }
  ],
  "orderMessages": [
    {
      "code": "string",
      "type": "string",
      "Message": "string"
    }
  ],
  "customerOrderAttributes": [
    {
      "attribute": "string"
    }
  ],
  "orderPlacedTime": "string",
  "paymentType": "string",
  "currencyISO": "string",
  "totalTax": 0,
  "checkoutProfileIdentifier": "string",
  "totalDeliveryCost": 0,
  "totalDiscount": 0,
  "couponCodes": "string"
}

Wenn Sie bereit sind, einen Produktionsbestellung aufzugeben, überprüfen Sie alle Parameter, die Sie in der Nutzlast der Anfrage senden möchten, und verwenden Sie die URL ".../store/orders". Weitere Informationen zu Test- und Produktivbestellungen finden Sie auf der Seite Dokumentation zur Bestell-API.

 

Schritt 6: Abfrage der Auftragsdetails

 

Weitere Informationen zum Bestellen und zu den verfügbaren Bestelldetails finden Sie auf der Seite Dokumentation zur Bestell-API.

Beispielanforderung:

curl --request GET \
--url 'https://transact.ti.com/v2/store/orders/{orderNumber}'
--header 'Authorization: Bearer {access_token}' \

Beispielantwort:

{
  "orderNumber": 0,
  "orderStatus": "string",
  "customerPurchaseOrderNumber": "string",
  "subTotal": 0,
  "totalPrice": 0,
  "lineItems": [
    {
      "tiPartNumber": "string",
      "tiPartDescription": "string",
      "quantity": "string",
      "status": "string",
      "unitPrice": 0,
      "customReelIndicator": true
    }
  ],
  "shippingAddress": [
    {
      "addressType": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "town": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "email": "string",
      "phoneNumber": "string",
      "companyURL": "string"
    }
  ],
  "billingAddress": [
    {
      "addressType": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "town": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "email": "string",
      "phoneNumber": "string",
      "companyURL": "string"
    }
  ],
  "orderMessages": [
    {
      "code": "string",
      "type": "string",
      "Message": "string"
    }
  ],
  "customerOrderAttributes": [
    {
      "attribute": "string"
    }
  ],
  "orderPlacedTime": "string",
  "paymentType": "string",
  "currencyISO": "string",
  "totalTax": 0,
  "checkoutProfileIdentifier": "string",
  "totalDeliveryCost": 0,
  "totalDiscount": 0,
  "couponCodes": "string"
}

Schritt 7: Sendungsverfolgung

 

Nach dem Verpacken Ihrer Bestellung generiert TI bei Versandbereitschaft Informationen zur Sendungsverfolgung, die über die Advanced Ship Notification (ASN)-API zugänglich sind. Die Antwort enthält detaillierte Informationen zu Ihrer Lieferung, wie Sendungsverfolgungsnummer, Spediteurinformationen und Handelsrechnungen. Die API ist als Push- oder als Retrieve-Implementierung verfügbar. 

Beispiel für eine Anfrage zum Abruf:

curl --request GET \
--url 'https://transact.ti.com/v2/store/orders/{orderNumber}/advanced-shipment-notices/{wayBillNumber}'
--header 'Authorization: Bearer {access_token}' \

Schritt 8: Abrufen einer Rechnung

 

Die Finanz-API liefert Rechnungsinformationen für Nicht-Apruve-Zahlungen. Um eine Rechnung über die Finanz-API abzurufen, ist die Bestellnummer ein erforderlicher Teil der JSON-Nutzdaten des Abrufs. Die Rechnungen werden verfügbar, nachdem TI die Bestellungen bearbeitet hat.

Für Rechnungen, die Apruve als Zahlungsmethode verwenden, navigieren Sie zu Ihrem Apruve-Portal, um Ihre Rechnung direkt zu erhalten.

Um eine PDF-Datei abzurufen, siehe Dokumentation zu den Konfigurationsoptionen.

Beispielanforderung:

curl --request GET \
--url 'https://transact.ti.com/v2/store/orders/{orderNumber}/financial-documents/{financialDocumentNumber}'
--header 'Authorization: Bearer {access_token}' \

Beispielantwort:

{
    "OrderNumber": "T02281839",
    "SupplierFinancialDocumentIdentifier": "1234567890",
    "TotalNumberOfDocuments": "1",
    "Documents": [
        {
            "SupplierDocumentType": "INVOICE",
            "SupplierFinancialDocumentIdentifier": "1234567890",
            "SupplierDocumentCreatedDate": "2020-05-11",
            "SupplierDocumentStatus": "CLEARED",
            "SupplierDocumentCurrency": "USD",
            "CustomerPurchaseOrderIdentifier": "PO1234",
            "CustomerReferenceIdentifier": "0100000200",
            "SupplierGrossWeight": "100.000",
            "SupplierNetWeight": "100.000",
            "SupplierWeightUnit": "GRM",
            "SupplierCarrier": "FEDEX EXPRESS",
            "DocumentValue": {
                "SupplierTotalAmount": "15,000.00"
            },
            "SalesOrder": {
                "SupplierOrderIdentifier": "1000001234",
                "SupplierOrderLineItemNumber": "000000",
                "CustomerPurchaseOrderIdentifier": "PO1234",
                "CustomerPurchaseOrderDate": "2020-01-01"
            },
            "PaymentTerms": {
                "SupplierIncoterms1": "TERMS1",
                "SupplierIncoterms2": "TERMS2",
                "SupplierTermsOfDelivery": "SHIPPING TERMS",
                "SupplierTermsOfPayment": "Net XX Days from Invoice Date",
                "PaymentTermsText": [
                    {
                        "SupplierPaymentTermsText": "Up to XX.XX.2020 without deduction"
                    }
                ]
            },
            "CreditManager": {
                "SupplierCreditManagerName": "Bill Johnson",
                "SupplierCreditManagerTelephone": "1234567890",
                "SupplierCreditManagerEmail": "bj-noreply@ti.com"
            },
            "Delivery": {
                "SupplierDeliveryIdentifier": "0200000300",
                "SupplierDeliveryLineItemNumber": "000000",
                "SupplierDeliveryDate": "2020-04-13",
                "SupplierGoodsMovementDate": "2020-05-11"
            },
            "Waybill": {
                "SupplierWaybillNumber": "123456",
                "SupplierNumberOfBoxes": "1"
            },
            "Partners": [
                {
                    "PartnerTypeDescription": "Sender",
                    "Name1": "Texas Instruments Incorporated",
                    "Name2": "Semiconductor",
                    "StreetAddress": "12500 TI Boulevard",
                    "City": "Dallas",
                    "Region": "TX",
                    "PostalCode": "75243",
                    "Country": "US"
                },
...

 

Schritt 9: Wo finden Sie technische Unterstützung?

Technische Unterstützung erhalten Sie in den TI E2E™ Design-Support-Foren oder indem Sie eine Frage stellen.