Skip to content

API Examples

Ingest Article

Use the Articles API endpoint to ingest an article:
https://portal.hyphensocial.com/api/publisher-api/v1/articles

Example payload: 

{
  "id": "art1234567890",
  "url": "https://www.wired.com/gallery/best-noise-canceling-headphones/",
  "title": "The Best Noise-Canceling Headphones",
  "intro": "Shaking off the world and sinking into a new album can feel like a train ride through the countryside unless you're sharing that seat with two young toddlers. Or if your neighbor’s dog is barking. Come to think of it, there are a lot of sounds that can ruin a good song. That's why we have headphones that isolate and cancel out noise. Below are the best noise-canceling headphones and earbuds you can buy, handpicked and tested by the Gear team here at WIRED.",
  "updatedDate": "2025-07-26T10:03:00-04:00",
  "publishedDate": "2018-12-09T08:00:00-05:00",
  "productBlocks": [
    {
      "blockId": "art1234567890_block_1",
      "blockHeadline": "A Close Second",
      "blockBody": "Sony redesigned the exterior of its popular flagship headphones for the fifth generation (9/10, WIRED Recommends), making them a bit sleeker and more competitive with Apple and Bose in looks. What didn't go away is the company's excellent noise cancellation, super customizable sound, and fantastic battery life. They're pricier than previous generations, but the sound is more absorbing, with a more energetic feel than the less dynamic models that came before.",
      "blockImage": "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
      "productId": "4548736132627",
      "productName": "Sony WH-1000XM5 Premium Noise Canceling Headphones",
      "productBrand": "Sony",
      "productImages": [
        "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
        "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
        "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg"
      ],
      "productOffers": [
        {
          "merchant": "Amazon",
          "url": "https://www.amazon.com/dp/B09XS7JWHH?asc_source=verso&asc_campaign=b12345678900ff2d9b5063d4&asc_refurl=https%3A%2F%2Fwww.wired.com%2Fgallery%2Fbest-noise-canceling-headphones&ascsubtag1234f8b99840ff2d9b5063d4&tag=hello-20",
          "affiliateNetwork": "Amazon"
        },
        {
          "merchant": "Walmart",
          "url": "https://goto.walmart.com/c/1305164/565706/9383?u=https%3A%2F%2Fwww.walmart.com%2Fip%2FSony-WH-1000XM5-Wireless-Industry-Leading-Noise-Canceling-Headphones-Black%2F3323306909&subId1=b12345678900ff2d9b5063d4%7C%7Ci4RzThqoPtCN6CPQAXj9Mg&sharedId=best-noise-canceling-headphones",
          "affiliateNetwork": "Impact"
        },
        {
          "merchant": "B&H Photo",
          "url": "https://go.skimresources.com/?id=100099X1555751&url=https%3A%2F%2Fwww.bhphotovideo.com%2Fc%2Fproduct%2F1706394-REG%2Fsony_wh1000xm5_s_wh_1000xm5_noise_canceling_wireless_over_ear.html&sref=https%3A%2F%2Fwww.wired.com%2Fgallery%2Fbest-noise-canceling-headphones&xcust=b12345678900ff2d9b5063d4%7C%7C3iWA5UqheSJ7aDMtn1qzfz",
          "affiliateNetwork": "Skimlinks"
        }
      ]
    }
  ]
}

Important Considerations

id - A publisher ID that uniquely identifies the article.
productBlocks[].blockId - A publisher ID that uniquely identifies the article product block.
productBlocks[].blockImage - The article product block primary image.
productBlocks[].productId - A publisher ID that uniquely identifies the product.
productOffers[].url - Must be a raw affiliate URL with visible query parameters.

Listing Articles

Use the Articles API endpoint to list articles:
https://portal.hyphensocial.com/api/publisher-api/v1/articles 

curl -X GET \
  https://portal.hyphensocial.com/api/publisher-api/v1/articles \
  -H "accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"

Example payload: 

{
  "items": [
    {
      "id": "art1234567890",
      "url": "https://www.wired.com/gallery/best-noise-canceling-headphones/",
      "title": "The Best Noise-Canceling Headphones",
      "intro": "Shaking off the world and sinking into a new album can feel like a train ride through the countryside unless you're sharing that seat with two young toddlers. Or if your neighbor’s dog is barking. Come to think of it, there are a lot of sounds that can ruin a good song. That's why we have headphones that isolate and cancel out noise. Below are the best noise-canceling headphones and earbuds you can buy, handpicked and tested by the Gear team here at WIRED.",
      "updatedDate": "2025-07-26T14:03:00Z",
      "publishedDate": "2018-12-09T13:00:00Z",
      "productBlocks": [
        {
          "blockHeadline": "A Close Second",
          "blockBody": "Sony redesigned the exterior of its popular flagship headphones for the fifth generation (9/10, WIRED Recommends), making them a bit sleeker and more competitive with Apple and Bose in looks. What didn't go away is the company's excellent noise cancellation, super customizable sound, and fantastic battery life. They're pricier than previous generations, but the sound is more absorbing, with a more energetic feel than the less dynamic models that came before.",
          "internalProductId": "THwKU7kTTgrtqLkovv3sYS",
          "productId": "4548736132627",
          "productName": "Sony WH-1000XM5 Premium Noise Canceling Headphones",
          "productDescription": "",
          "productBrand": "Sony",
          "productImages": [
            "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
            "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
            "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg"
          ],
          "productOffers": [
            {
              "merchant": "Amazon",
              "affiliateNetwork": "Amazon",
              "url": "https://www.amazon.com/dp/B09XS7JWHH?asc_source=verso&asc_campaign=b12345678900ff2d9b5063d4&asc_refurl=https%3A%2F%2Fwww.wired.com%2Fgallery%2Fbest-noise-canceling-headphones&ascsubtag1234f8b99840ff2d9b5063d4&tag=hello-20"
            },
            {
              "merchant": "Walmart",
              "affiliateNetwork": "Impact",
              "url": "https://goto.walmart.com/c/1305164/565706/9383?u=https%3A%2F%2Fwww.walmart.com%2Fip%2FSony-WH-1000XM5-Wireless-Industry-Leading-Noise-Canceling-Headphones-Black%2F3323306909&subId1=b12345678900ff2d9b5063d4%7C%7Ci4RzThqoPtCN6CPQAXj9Mg&sharedId=best-noise-canceling-headphones"
            },
            {
              "merchant": "B&H Photo",
              "affiliateNetwork": "Skimlinks",
              "url": "https://go.skimresources.com/?id=100099X1555751&url=https%3A%2F%2Fwww.bhphotovideo.com%2Fc%2Fproduct%2F1706394-REG%2Fsony_wh1000xm5_s_wh_1000xm5_noise_canceling_wireless_over_ear.html&sref=https%3A%2F%2Fwww.wired.com%2Fgallery%2Fbest-noise-canceling-headphones&xcust=b12345678900ff2d9b5063d4%7C%7C3iWA5UqheSJ7aDMtn1qzfz"
            }
          ]
        }
      ]
    }
  ],
  "count": 1
}

Listing Products

Use the Products API endpoint to list products:
https://portal.hyphensocial.com/api/publisher-api/v1/products 

curl -X GET \
  https://portal.hyphensocial.com/api/publisher-api/v1/products \
  -H "accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"

Example payload: 

{
  "items": [
    {
      "internalProductId": "THwKU7kTTgrtqLkovv3sYS",
      "productId": "4548736132627",
      "name": "Sony WH-1000XM5 Premium Noise Canceling Headphones",
      "description": "",
      "brand": "Sony",
      "images": [
        "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
        "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg",
        "https://media.wired.com/photos/627bfd36a4fb038463303e27/4:3/w_1920%2Cc_limit/Sony-WH-1000MX5-Gear.jpg"
      ],
      "offers": [
        {
          "merchant": "Amazon",
          "affiliateNetwork": "Amazon",
          "url": "https://www.amazon.com/dp/B09XS7JWHH?asc_source=verso&asc_campaign=b12345678900ff2d9b5063d4&asc_refurl=https%3A%2F%2Fwww.wired.com%2Fgallery%2Fbest-noise-canceling-headphones&ascsubtag1234f8b99840ff2d9b5063d4&tag=hello-20"
        },
        {
          "merchant": "Walmart",
          "affiliateNetwork": "Impact",
          "url": "https://goto.walmart.com/c/1305164/565706/9383?u=https%3A%2F%2Fwww.walmart.com%2Fip%2FSony-WH-1000XM5-Wireless-Industry-Leading-Noise-Canceling-Headphones-Black%2F3323306909&subId1=b12345678900ff2d9b5063d4%7C%7Ci4RzThqoPtCN6CPQAXj9Mg&sharedId=best-noise-canceling-headphones"
        },
        {
          "merchant": "B&H Photo",
          "affiliateNetwork": "Skimlinks",
          "url": "https://go.skimresources.com/?id=100099X1555751&url=https%3A%2F%2Fwww.bhphotovideo.com%2Fc%2Fproduct%2F1706394-REG%2Fsony_wh1000xm5_s_wh_1000xm5_noise_canceling_wireless_over_ear.html&sref=https%3A%2F%2Fwww.wired.com%2Fgallery%2Fbest-noise-canceling-headphones&xcust=b12345678900ff2d9b5063d4%7C%7C3iWA5UqheSJ7aDMtn1qzfz"
        }
      ]
    }
  ],
  "count": 1
}