[Skip to main content](#vessel-content)

#   Please make a tutorial

##

- **[immersiva](/forum/user/10742-immersiva "View immersiva's Profile")**
- [![immersiva's Avatar](https://www.hikashop.com/media/kunena/core/svg/person.svg)](/forum/user/10742-immersiva "View immersiva's Profile") Topic Author
- [ Offline](/forum/user/10742-immersiva)

Less More

- Posts: 2
- Thank you received: 1
-
-

13 years 11 months ago [\#74274](#74274) by [immersiva](/forum/user/10742-immersiva "View immersiva's Profile")  *[Please make a tutorial](/forum/17-serial-how-to/74274-please-make-a-tutorial#74274 "Hi,  I'm trying to create a plugin for HikaSerial, so that I can finish this workflow:  Objective: A store for digital products a) with only one (for now) dowloadable digital product b) configure simple checkout process with paypal payment and a digital product (file) download c) when the game is bought an email is sent to the user with a custom serial number. For instance, the serial number can be something like: md5(+'somerandomstring' + reissues&#95;counter) d) serials can be re-generated for a specific user (thus the reissues&#95;counter thing) e) when the user starts to play the game: e.1 - s/he enters his/her login and serial number e.2 - the game client sends the data to the server invoking an HTTP URL (php script) e.3 - the game site/server validates the information and sends the client a response  I installed hikashop and hikaserial, but how to I get started creating this plugin.  A basic tutorial would be great, instead of searching bits of information here and there on this forum.  For instance, which files do I need to create and where do I put them? How do I consume a serial in step e.2?  TIA, Rod")* was created by *[immersiva](/forum/user/10742-immersiva "View immersiva's Profile")*

Hi,

I'm trying to create a plugin for HikaSerial, so that I can finish this workflow:

Objective: A store for digital products
a) with only one (for now) dowloadable digital product
b) configure simple checkout process with paypal payment and a digital product (file) download
c) when the game is bought an email is sent to the user with a custom serial number. For instance, the serial number can be something like: md5(&lt;user email&gt;+'somerandomstring' + reissues_counter)
d) serials can be re-generated for a specific user (thus the reissues_counter thing)
e) when the user starts to play the game:
e.1 - s/he enters his/her login and serial number
e.2 - the game client sends the data to the server invoking an HTTP URL (php script)
e.3 - the game site/server validates the information and sends the client a response

I installed hikashop and hikaserial, but how to I get started creating this plugin.

A basic tutorial would be great, instead of searching bits of information here and there on this forum.

For instance, which files do I need to create and where do I put them?
How do I consume a serial in step e.2?

TIA,
Rod

Please [Log in](/login?return=aHR0cHM6Ly93d3cuaGlrYXNob3AuY29tL2ZvcnVtLzE3LXNlcmlhbC1ob3ctdG8vNzQyNzQtcGxlYXNlLW1ha2UtYS10dXRvcmlhbD90bXBsPW1hcmtkb3du) or [Create an account](/register) to join the conversation.

- **[Jerome](/forum/user/80-jerome "View Jerome's Profile")**
- [![Jerome's Avatar](https://www.hikashop.com/media/kunena/avatars/resized/size144/users/avatar80.png)](/forum/user/80-jerome "View Jerome's Profile")
- [ Offline](/forum/user/80-jerome)
- HikaShop core developer

Less More

- Posts: 26394
- Thank you received: 4078
-
- [](http://obsi.dev)
-

13 years 11 months ago [\#74283](#74283) by [Jerome](/forum/user/80-jerome "View Jerome's Profile")  Replied by *[Jerome](/forum/user/80-jerome "View Jerome's Profile")* on topic *[Re: Please make a tutorial](/forum/17-serial-how-to/74274-please-make-a-tutorial#74283 "Hi,  I'm trying to create a plugin for HikaSerial, so that I can finish this workflow:  Objective: A store for digital products a) with only one (for now) dowloadable digital product b) configure simple checkout process with paypal payment and a digital product (file) download c) when the game is bought an email is sent to the user with a custom serial number. For instance, the serial number can be something like: md5(+'somerandomstring' + reissues&#95;counter) d) serials can be re-generated for a specific user (thus the reissues&#95;counter thing) e) when the user starts to play the game: e.1 - s/he enters his/her login and serial number e.2 - the game client sends the data to the server invoking an HTTP URL (php script) e.3 - the game site/server validates the information and sends the client a response  I installed hikashop and hikaserial, but how to I get started creating this plugin.  A basic tutorial would be great, instead of searching bits of information here and there on this forum.  For instance, which files do I need to create and where do I put them? How do I consume a serial in step e.2?  TIA, Rod")*

Hi,

Did you look at the developer documentation ?
[ www.hikashop.com/en/hikashop/125-hikaserial-developer.html](http://www.hikashop.com/en/hikashop/125-hikaserial-developer.html)

Some documentation about the "consume" is missing but we will work on documentation this week.
I will include some information about HikaSerial webservices too.

The consume html page is: Code:

index.php?option=com_hikaserial&amp;ctrl=serial&amp;task=consume

Using webservices, in the front end, to check a serial, you can call an url like this : Code:

index.php?option=com_hikaserial&amp;ctrl=serial&amp;task=check&amp;hikaserial[serial]=YOUR_SERIAL_DATA&amp;hikaserial[format]=xml

It would result something like this: Code:

&lt;hikaserial&gt; &lt;serials&gt; &lt;serial status="unassigned" date="1333535893"&gt; &lt;data&gt;&lt;![CDATA[YOUR_SERIAL_DATA]]&gt;&lt;/data&gt; &lt;extradata&gt; &lt;computer_name&gt;&lt;![CDATA[the computer name]]&gt;&lt;/computer_name&gt; &lt;/extradata&gt; &lt;/serial&gt; &lt;/serials&gt; &lt;/hikaserial&gt;

You can use XML, JSON and HTML formats.

After that, there is the "consume" feature.
You can consume a serial which is "assigned".
For example, I can call the URL Code:

/index.php?option=com_hikaserial&amp;ctrl=serial&amp;task=consume&amp;hikaserial[serial_data]=YOUR_SERIAL_DATA&amp;hikaserial[serial_extra_data][myUser]=Jerome&amp;hikaserial[format]=json

And I received: Code:

{"consume":{"status":"assigned","date":"0","data":"YOUR_SERIAL_DATA","extradata":{"myUser":"Jerome"}}}

The webservice is compatible with html POST request.
So you can make a post request to the url Code:

/index.php?option=com_hikaserial&amp;ctrl=serial&amp;task=consume

And give the rest of the parameters by POST ( hikaserial[serial_data] / hikaserial[format] / hikaserial[serial_extra_data][] )

Regards,

---

Jerome - Obsidev.com
HikaMarket &amp; HikaSerial developer / HikaShop core dev team.

Please [Log in](/login?return=aHR0cHM6Ly93d3cuaGlrYXNob3AuY29tL2ZvcnVtLzE3LXNlcmlhbC1ob3ctdG8vNzQyNzQtcGxlYXNlLW1ha2UtYS10dXRvcmlhbD90bXBsPW1hcmtkb3du) or [Create an account](/register) to join the conversation.

- **[Jerome](/forum/user/80-jerome "View Jerome's Profile")**
- [![Jerome's Avatar](https://www.hikashop.com/media/kunena/avatars/resized/size144/users/avatar80.png)](/forum/user/80-jerome "View Jerome's Profile")
- [ Offline](/forum/user/80-jerome)
- HikaShop core developer

Less More

- Posts: 26394
- Thank you received: 4078
-
- [](http://obsi.dev)
-

13 years 11 months ago [\#74308](#74308) by [Jerome](/forum/user/80-jerome "View Jerome's Profile")  Replied by *[Jerome](/forum/user/80-jerome "View Jerome's Profile")* on topic *[Re: Please make a tutorial](/forum/17-serial-how-to/74274-please-make-a-tutorial#74308 "Hi,  I'm trying to create a plugin for HikaSerial, so that I can finish this workflow:  Objective: A store for digital products a) with only one (for now) dowloadable digital product b) configure simple checkout process with paypal payment and a digital product (file) download c) when the game is bought an email is sent to the user with a custom serial number. For instance, the serial number can be something like: md5(+'somerandomstring' + reissues&#95;counter) d) serials can be re-generated for a specific user (thus the reissues&#95;counter thing) e) when the user starts to play the game: e.1 - s/he enters his/her login and serial number e.2 - the game client sends the data to the server invoking an HTTP URL (php script) e.3 - the game site/server validates the information and sends the client a response  I installed hikashop and hikaserial, but how to I get started creating this plugin.  A basic tutorial would be great, instead of searching bits of information here and there on this forum.  For instance, which files do I need to create and where do I put them? How do I consume a serial in step e.2?  TIA, Rod")*

Hi,

The documentation has been updated.
There is now a dedicated page to the consume feature: [ www.hikashop.com/en/hikashop/138-hikaserial-consume.html](http://www.hikashop.com/en/hikashop/138-hikaserial-consume.html)

Regards,

---

Jerome - Obsidev.com
HikaMarket &amp; HikaSerial developer / HikaShop core dev team.

Please [Log in](/login?return=aHR0cHM6Ly93d3cuaGlrYXNob3AuY29tL2ZvcnVtLzE3LXNlcmlhbC1ob3ctdG8vNzQyNzQtcGxlYXNlLW1ha2UtYS10dXRvcmlhbD90bXBsPW1hcmtkb3du) or [Create an account](/register) to join the conversation.

- **[immersiva](/forum/user/10742-immersiva "View immersiva's Profile")**
- [![immersiva's Avatar](https://www.hikashop.com/media/kunena/core/svg/person.svg)](/forum/user/10742-immersiva "View immersiva's Profile") Topic Author
- [ Offline](/forum/user/10742-immersiva)

Less More

- Posts: 2
- Thank you received: 1
-
-

13 years 11 months ago [\#74539](#74539) by [immersiva](/forum/user/10742-immersiva "View immersiva's Profile")  Replied by *[immersiva](/forum/user/10742-immersiva "View immersiva's Profile")* on topic *[Re: Please make a tutorial](/forum/17-serial-how-to/74274-please-make-a-tutorial#74539 "Hi,  I'm trying to create a plugin for HikaSerial, so that I can finish this workflow:  Objective: A store for digital products a) with only one (for now) dowloadable digital product b) configure simple checkout process with paypal payment and a digital product (file) download c) when the game is bought an email is sent to the user with a custom serial number. For instance, the serial number can be something like: md5(+'somerandomstring' + reissues&#95;counter) d) serials can be re-generated for a specific user (thus the reissues&#95;counter thing) e) when the user starts to play the game: e.1 - s/he enters his/her login and serial number e.2 - the game client sends the data to the server invoking an HTTP URL (php script) e.3 - the game site/server validates the information and sends the client a response  I installed hikashop and hikaserial, but how to I get started creating this plugin.  A basic tutorial would be great, instead of searching bits of information here and there on this forum.  For instance, which files do I need to create and where do I put them? How do I consume a serial in step e.2?  TIA, Rod")*

Hi Jerome,

Thanks for your promptly reply.

I think it's useful to document that the developer should look in /plugin/hikaserial/ for examples. Since I came from a different programming background I don't know upfront where joomla things are located. ![:)](/media/kunena/emoticons/3.png ":)")

Thanks again,

R.

The following user(s) said Thank You: [Jerome](/forum/user/80-jerome "View Jerome's Profile")

Please [Log in](/login?return=aHR0cHM6Ly93d3cuaGlrYXNob3AuY29tL2ZvcnVtLzE3LXNlcmlhbC1ob3ctdG8vNzQyNzQtcGxlYXNlLW1ha2UtYS10dXRvcmlhbD90bXBsPW1hcmtkb3du) or [Create an account](/register) to join the conversation.

Board Categories HikaShop Install &amp; Update Product &amp; Category Display Content Creation Sales and Orders Orders management Reports &amp; Statistics Customers Checkout Payment Methods Shipping Methods Import &amp; Export (CSV, XLS…) Specific Features Affilation Taxes Wishlist Vote Carousel &amp; Slider Mass Actions Filters &amp; Search Discount &amp; Coupon Feature Request Integrations Showcase General Talk about HikaShop Development HikaShop 3.0 Beta Translation Commercial Jobs HikaShop Components HikaMarket Market: Feature requests Market: How to? Market: Bug Report HikaSerial General talk about HikaSerial Serial: Bug Report Serial: How to? Support en Français de HikaSerial (French Support) HikaSubscription HikaAuction Auction: Feature requests Auction: How to? Auction: Bug report Hikashop around the world Support en Français (French Support) Russian FAQ. Курс выживания с Hikashop. Частые вопросы и о Расширения Hikashop Наши сайты на Hikashop 日本語版サポート(Japanese Support) Thai German Archives Bug Report How to?

Moderators: [Obsidev](/forum/user/7040-obsidev "View Obsidev's Profile")

[](/forum/topics/feed/mode-topics?format=feed&type=rss)

Time to create page: 0.063 seconds

[Powered by](/forum/credits) [Kunena Forum](https://www.kunena.org)
