Miva Merchant 5.5 API Documentation

[burch]

New Miva Merchant API documentation is now available at:

http://www.mivamerchant.com/support/docs/technical/

The build process we are using for this documentation pulls the text straight out of our source code, and shoves it through a tool called doxygen.

We plan on making this document generation process part of our development process, so the documentation will remain up to date.

While the current documentation is not complete, we will be updating the documentation slowly over time with the final goal being 100% coverage of the Module API, MivaScript language, and source code in the MMLSK.

[burch]

Re: Miva Merchant 5.5 API Documentation

Edited: See above.

[Nerd Boy Inc]

Re: Miva Merchant 5.5 API Documentation

Dear Jon,

Any way to get what should be Returned listed as well?

[burch]

Re: Miva Merchant 5.5 API Documentation

For the functions that are documented (beyond the simple list of functions), the expected return value is included.

Like I said we'll be chipping away at the rest of the functions with the hopes of having the API fully documented in a few weeks.

[Nerd Boy Inc]

Re: Miva Merchant 5.5 API Documentation

Dear Jon,

Yea, I just happen to be going through the ones not done yet.

Thanks!

[Jeff - Wolfpaw Hosting]

Re: Miva Merchant 5.5 API Documentation

Jon:

Just a reminder from the module session at the conference. For those of us still working on V4 modules could you please check that we have searchable access to the old miva mailing lists. By the way that was a great session!

[burch]

Re: Miva Merchant 5.5 API Documentation

Jon:

Just a reminder from the module session at the conference. For those of us still working on V4 modules could you please check that we have searchable access to the old miva mailing lists. By the way that was a great session!

All right Jeff, look at the bottom of the forum list and you'll find that I've managed to import the archives from the old mailing lists into the forum software. It's even indexed like any other forum content.

The import isn't perfect (nor was the source data), but it's all there. Even the flamewars.

[Jeff - Wolfpaw Hosting]

Re: Miva Merchant 5.5 API Documentation

Jon - fantastic. It will be a great help.

[burch]

Re: Miva Merchant 5.5 API Documentation

We released a new version of the documentation today that includes:

1. Documentation on the tokens and render code provided by all cmp-mv-xxx components
2. Documentation for all vis_xxx module features
3. Complete documentation of the "payment" module feature, including new additions in Wombat (PR7)
4. Function lists showing function names and parameters for new admin UI functions and AJAX calls that will be in the PR7 LSK
5. DB documentation for lib/dbprim/attributes.mv, lib/dbprim/basketitems.mv, lib/dbprim/options.mv

Again, the URL to access both the PDF and (searchable) HTML versions of the documentation is http://www.mivamerchant.com/support/...cal/index.html

[insanedragons]

Miva Merchant 5 5 API Documentation

Thanks for your input.

I setup the Miva Merchant for authorize only on Credit Cards but the Card information is not sent to my PC. I have to go to my admin page to obtain card info. and expiry date. Can I set Miva to send me all the info so I dont have to go through so much hassle to process the cards in my office?

[RayYates]

Re: Miva Merchant 5.5 API Documentation

I just posted a this suplimental documentation to the PR7 LSK on our website.

http://www.pcinet-llc.com/docs/MM5_LSK_Function_List_PR7.html

You can bookmark but even better is to save this html file to the mm5/ folder where you unpacked the LSK. You will then be able to open it and click on a filename to open the file in your favorite editor. You may have to tweak your browser settings to prevent opening in the browser itself.

enjoy

[RayYates]

Re: Miva Merchant 5.5 API Documentation

For PR8, has the LSK and the API been updated?

http://www.mivamerchant.com/support/downloads

http://www.mivamerchant.com/support/docs/api

[burch]

Re: Miva Merchant 5.5 API Documentation

The LSK has been updated, the documentation has not. I don't know when we will get the documentation updated, sorry.

[RayYates]

Re: Miva Merchant 5.5 API Documentation

Thank Burch

That's good to know about the LSK. I'll get into it next week.

As for the API, in particular I'm interested in the new API for the batches tabs. If you can post something about those I can wait for the rest.

[burch]

Re: Miva Merchant 5.5 API Documentation

I assume you mean the batch edit screen tabs. If you have one of the vis_XXXbe features enabled and your module reports an api_ver of 5.70 or newer, the following two functions will be called (I'm using product batch edit as the example here, the function naming is consistent with the other vis_XXXbe functions for different features):

Module_Product_BatchEdit_Tabs( module var )
Module_Product_BatchEdit_Content( module var, tab, load_fields )

5.70 or newer API modules' Module_Product_BatchEdit_Validate() are always called (older modules are only called when updating in edit here mode)

Module_Product_BatchEdit_Update( module var, product var ) and
Module_Product_BatchEdit_Delete( module var, product var ) are unchanged from previous versions.