ACCESSTRADE-Support

Website APIs

Get Website List

• GET /v1/publishers/me/sites
• Publisher API Authentication required
• Request: empty
• Response:
  • 200 OK on success

    [
    {
        "id": 2,
        "name": "Interspace Test",
        "url": "http://accesstrade.co.id",
        "status": "APPROVED"
    },
    {
        "id": 10737,
        "name": "test site",
        "url": "http://example.test.com/",
        "status": "REVIEWING"
    }
    ]
    

    Get Website Details

• GET /v1/publishers/me/sites/${siteId}
  • siteId: numeric ID of the site
• Publisher API Authentication required
• Request: empty
• Response:
  • 200 OK on success
  • 404 Not Found if the site is not found for the logged-in publisher

    {
    "name": "test site updated",
    "url": "http://example.test.com/updated",
    "type": "COMMUNITY",
    "status": "REVIEWING",
    "categories":
    [
        {
          "name":"Trading",
          "value":4
        },
        {
          "name":"Games",
          "value":20
        }
    ],
    "description": "my site description",
    "traffic": "TWITTER",
    "leadGeneration": "CASHBACK"
    }
    

• categories: a list of category IDs of the given website

  Create Website

• PUT /v1/publishers/me/sites
• Publisher API Authentication required
• Request:

  {
  "name": "test site",
  "url": "http://example.test.com",
  "type": "BLOG",
  "categories": [
    {
  　　　　"value": 1
    },
    {
  　　　　"value": 10
    }
  ],
  "description": "test site for testing adding a new site",
  "traffic": "TWITTER",
  "leadGeneration": "CASHBACK"
  }
  

• categories: a list of IDs of the categories to be added to the given website
• Constraints:
  • name: required
  • url: required
  • categories: at most 2 categories are allowed
• Response:
  • 200 OK on success

    {
    "id": 12
    }
    

    Update Website

• PUT /v1/publishers/me/sites
• Publisher API Authentication required
• Request:

  {
    "id": 1,
    "name": "test site updated",
    "url": "http://example.test.com/updated",
    "type": "COMMUNITY",
    "description": "updated description",
    "categories": [
        {
  　　　　      "value": 5
        },
        {
  　　　　      "value": 11
        }
    ],
    "traffic": "TWITTER",
    "leadGeneration": "CASHBACK"
  }
  

  The request path is the same as for Create Website above. The only difference is in the request body: the update request contains the ID of the site-to-be-updated along with all the details that are also present in the Create Website request. The request represents the site in the way it should look like after the update. So any fields not sent in the request will be updated to an empty value!

• categories: A list of the new category IDs of the given site. To remove categories from the site, just leave their IDs out of the request.
• Updatable fields:
  • categories: at most 2 categories are allowed
  • description: optional
  • name: required
  • type: required
  • url: required
• Response:
  • 200 OK on success
  • 400 Bad Request if any of the constraints is not met
  • 404 Not Found if the site is not found for the logged-in publisher

    { 
    "id": 12
    }
    

    Delete Website

• DELETE /v1/publishers/me/sites/{siteId}
  • siteId: numeric ID of the site
• Publisher API Authentication required
• Request: empty
• Response:
  • 200 OK on success
  • 404 Not Found if the site is not found for the logged-in publisher

Site Types

• The possible values that are used in the site APIs are listed below:
  • BLOG
  • REWARD_POINT
  • SEARCH_ENGINE
  • COMMUNITY
  • SOCIAL_NETWORK
  • FORUM
  • COUPON
  • PORTAL
  • CASHBACK

Site Statuses

• The possible values that are used in the site APIs are listed below:
  • REVIEWING
  • APPROVED
  • REJECTED
  • DELETED

Site Traffic

• The possible values that are used in the site APIs are listed below:
  • ORGANIC_SEARCH
  • PAID_SEARCH
  • OTHER_ORGANIC_TRAFFIC
  • OTHER_PAID_TRAFFIC
  • FACEBOOK_PAGE
  • FACEBOOK_ADS
  • YOUTUBE_CHANNEL
  • TWITTER
  • INSTAGRAM
  • OTHER_SOCIAL_NETWORK
  • EMAIL_MARKETING

Site Lead Generation

• The possible values that are used in the site APIs are listed below:
  • PRODUCT_AND_SERVICE_REVIEW
  • COUPON
  • OTHER_DISCOUNT_INFORMATION
  • CASHBACK
  • REWARD_POINT
  • PRICE_COMPARISON
  • PROMOTION_BANNER