Información general

Para comenzar con la suite API de TI Store, siga estos pasos: 

  1. Requisitos previos para el acceso y el desarrollo
  2. Revise el flujo de pedidos típico con la suite API de TI Store.
  3. Autentíquese para recibir un token de acceso.
  4. Conozca cómo consultar la información de inventario y los precios.
  5. Cree un pedido de prueba.
  6. Acceda a la información de su pedido.
  7. Conozca cómo recuperar el seguimiento de envíos.
  8. Conozca cómo recuperar una factura.
  9. Obtenga soporte.

 

Paso 1: Requisitos previos

 

Solo los clientes aprobados pueden crear aplicaciones mediante la suite API de TI Store. Para obtener la autorización:

  1. Cree una cuenta myTI o inicie sesión en su cuenta myTI existente.
  2. Cree una cuenta de empresa myTI.
  3. Haga clic en Solicitar en la página Acceso y claves de API.

 

Paso 2: Descripción general del flujo de pedidos

 

  1. Autentíquese con la clave de API y la palabra secreta asignadas.
  2. Envíe una consulta a la API de inventario y precios para recuperar la disponibilidad de inventario y demás información relacionada. 
  3. La API responderá con un código de estado, 200 OK y una respuesta JSON (JavaScript Object Notation) que contiene los datos de los producto solicitados.
  4. Cree su pedido con la carga útil deseada y envíelo a la API de pedidos.
  5. La API responderá con un código de estado, 200 OK y un JSON que contenga el acuse de recibo del pedido.
  6. Consulte la API de pedidos para conocer el estado y los detalles adicionales del pedido.
  7. Después del procesamiento del pedido, recupere el seguimiento de envíos a través de la API de recuperación de avisos de envíos anticipados (ASN) y las facturas a través de la API de recuperación de documentos financieros.
  8. ¿Le interesa ver un código de ejemplo para cada uno de estos pasos? Descargue nuestro código de ejemplo.

 

 

Paso 3: Autenticar

 

TI ha asegurado sus suites API con OAuth 2.0. Utilice su clave de API y palabra secreta para autenticarse. Después de la autorización, OAuth2 devuelve un token de acceso que se utiliza con las API del conjunto de aplicaciones que ha habilitado. Para obtener más detalles, consulte la página de Autenticación.  

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

 

Paso 4: Consultar inventario y precios

 

El siguiente ejemplo, que ilustra cómo recuperar la disponibilidad de inventario y la información de precios por producto, corresponde a la consulta del número de pieza AFE7799IABJ. El inventario disponible es de 5435 ("cantidad": 5435). Sin embargo, en este ejemplo, la cantidad está restringida a un límite de 50 ("límite": 50) unidades por pedido. Si el producto no tiene un límite de pedidos, la respuesta JSON devolverá un valor en blanco en el campo de límite. Para obtener una lista de todos los parámetros relacionados con los productos, consulte la documentación que se muestra en la API de inventario y precios.

Ejemplo de solicitud: 

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

Respuesta a una solicitud correcta:

{
  "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"
}

 

Paso 5: Crear un pedido de prueba

 

Los pedidos de prueba son simulados; en otras palabras, no son órdenes enviadas y su intención solo es asistirle en el desarrollo de su aplicación. El inventario utilizado para realizar pedidos de prueba no disminuye ni se reserva. La información devuelta simula la información entregada por los datos de pedidos de producción, pero algunos campos son solo para fines demostrativos y no representan información procesada.

Para realizar un pedido (de prueba o producción), deben tener un perfil de pago apto para la API guardado en la cuenta de su empresa. Consulte la página Acceso y claves de API para obtener más información sobre la creación de cuentas de empresa y los perfiles de pago. Para seleccionar un perfil de pago para hacer referencia a su pedido, deberá recuperar el ID del perfil de pago desde la cuenta de su empresa. Puede encontrar perfiles de pago en el panel de myTI en Preferencias de pedido, Perfiles de pago. Como se muestra a continuación, en la página Perfiles de pago busque el ícono de copia en la columna de identificación junto al perfil de pago que desea utilizar.

 

Checkout profiles table with ID column highlighted

Copie el código que desea utilizar para su pedido.

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

Utilizando el checkoutProfileID, realice el POST de su pedido.

#!/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

Ejemplo de respuesta:

{
  "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"
}

Cuando esté listo para realizar un pedido de producción, revise todos los parámetros que desea enviar en la carga útil de la solicitud y utilice la URL ".../store/orders". Para obtener más información sobre los pedidos de pruebas y producción, consulte la página de documentación de la API de pedidos.

 

Paso 6: Consultar los detalles del pedido

 

Para obtener más información y detalles sobre los pedidos disponibles, consulte la página de documentación de la API de pedidos.

Ejemplo de solicitud:

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

Ejemplo de respuesta:

{
  "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"
}

Paso 7: Seguimiento de envíos

 

Después de embalar su pedido, cuando esté listo para enviarse, TI genera la información de seguimiento del envío a través de la API de notificaciones de avisos anticipados de embarque (ASN). La respuesta incluye información detallada sobre el envío, como el número de seguimiento de este, la información del transportista y las facturas comerciales. La API está disponible en implementaciones instantáneas o de recuperación

Ejemplo de solicitud de recuperación:

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

Paso 8: Recuperación de una factura

 

La API de finanzas proporciona información sobre las facturas de los pagos distintos a los de Apruve. Para recuperar una factura mediante la API de finanzas, el número de pedido es una parte necesaria de la carga JSON de la recuperación. Las facturas estarán disponibles después de que TI procese los pedidos.

Para las facturas que utilizan Apruve como método de pago, navegue hasta su portal de Apruve para obtener su factura directamente.

Para recuperar un PDF, consulte la documentación para ver las opciones de configuración.

Ejemplo de solicitud:

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

Ejemplo de respuesta:

{
    "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"
                },
...

 

Paso 9: Dónde obtener soporte técnico

Para obtener soporte técnico, consulte el foro de soporte de diseño de TI E2E™ o publique su pregunta.