1. Home
  2. Docs
  3. Kiwire ( v3 ) – API
  4. Ads

Ads



CREATE

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/ads/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
name string The name of the ads.
fn_desktop string For displaying ads on desktop.
fn_phone string For displaying ads on Mobile
fn_tablet string For displaying ads on Tablet.
type string The media type are:
  • Image : Image ads type, media type supported ( jpg, jpeg, png & gif )
  • Video : Video ads type, media type supported ( mp4 & ogg )
  • YouTube Video Link : YouTube video link, put the YouTube watch url into the link.
  • Message : Message ads, display a text message.
  • JSON Server : Display Ads using JSON
link string URL for the Link. For YouTube, paste the URL of the YouTube ads. * NOTE : Please put in the watch URL link e.g. “https://www.youtube.com/watch?v=mOO5qRjVFLw” but not the embedded link.
status y or n The status of the user whether active or expired.
msg string The message for the ads.
captcha_txt string Captcha that user have to key in to verify.
viewport string Set the scale of the ads
  • Fill : Scale the cover image to be as large as possible so that the SLIDE area is completely covered by the cover image. Some parts of the cover image may not be in view within the SLIDE positioning area.
  • Fit : Scale the cover image to the largest size such that only its width or its height can fit inside the SLIDE content area.
  • Stretch : Scale the cover image to the largest size such that both its width and its height can fit inside the SLIDE content area.
  • Center : Allows the cover image to be at its original size and in center.
remark string The remark for the ads.



PATCH

Use PATCH method is to make a partial update on a resource. 

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

Example request URIs

[PATCH] https://{{kiwire_ip}}/api/ads/{{id}}/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
name string The name of the ads.
fn_desktop string For displaying ads on desktop.
fn_phone string For displaying ads on Mobile
fn_tablet string For displaying ads on Tablet.
type string The media type are:
  • Image : Image ads type, media type supported ( jpg, jpeg, png & gif )
  • Video : Video ads type, media type supported ( mp4 & ogg )
  • YouTube Video Link : YouTube video link, put the YouTube watch url into the link.
  • Message : Message ads, display a text message.
  • JSON Server : Display Ads using JSON
link string URL for the Link. For YouTube, paste the URL of the YouTube ads. * NOTE : Please put in the watch URL link e.g. “https://www.youtube.com/watch?v=mOO5qRjVFLw” but not the embedded link.
status y or n The status of the user whether active or expired.
msg string The message for the ads.
captcha_txt string Captcha that user have to key in to verify.
viewport string Set the scale of the ads
  • Fill : Scale the cover image to be as large as possible so that the SLIDE area is completely covered by the cover image. Some parts of the cover image may not be in view within the SLIDE positioning area.
  • Fit : Scale the cover image to the largest size such that only its width or its height can fit inside the SLIDE content area.
  • Stretch : Scale the cover image to the largest size such that both its width and its height can fit inside the SLIDE content area.
  • Center : Allows the cover image to be at its original size and in center.
remark string The remark for the ads.



DELETE

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/ads/{{id}}/


GET

Use GET method to retrieve resource information only and not to modify it in any way.

Example request URIs

[GET] https://{{kiwire_ip}}/api/ads/ [GET] https://{{kiwire_ip}}/api/ads/{{id}}/ [GET] https://{{kiwire_ip}}/api/ads/{{offset}}/{{limit}}/{{column}}/{{order}}/
Value Description
offset integer Start data count
limit integer Limit data count
column string Column name
order desc or asc Sort the result set in ascending or descending order.

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg : https://{{kiwire_ip}}/api/ads/0/10/id/desc/