Mamut API Introduction document

Transcription

1 Mamut API Introduction document Contents Introduction... 2 What is the API?... 4 Why use the API?... 4 Sales Information... 4 FAQ... 5 Functionality Check List Mamut (examples not a definite list)... 6

2 Introduction Mamut API is a supplementary product to Mamut Business Software, which makes it possible for developers to export information from and enter information into the Mamut systems without using Mamut s normal user interface. The objective of the API documentation is to cover any questions and information needed to develop specific solutions. Knowledge of how Mamut Business Software works is also required. This document is developed and updated on an ongoing basis. Techncial questions about documentation, or other comments concerning the use of Mamut API, should be directed to the following address: api@mamut.com. The Mamut system saves all information in databases. Mamut is developed in Microsoft Visual FoxPro using a Microsoft SQL Server database. The database can be accessed in different ways using ODBC, OLEDB or ADO.NET. The ODBC driver enables all users with the required level of knowledge to read information from Mamut s database. It is possible to bring up specific sales statistics, specially adapted reports and so on. Mamut API can be used to expand the existing functionality in Mamut Business Software with Web Shop, data store, customized reports/statistics, and communication with other programs. The existing version of Mamut API supports those parts of Mamut s database that covers the contact, activity, document, order and product registers, journal entry, time sheet input and payroll (not in all markets). Sample Scenario: The user has, another program that contains customer information and invoicing data. This could be an industry-specific product that fulfils special of booking, E-commerce etc. With Mamut API, such a program can search for, change and create customers/contacts in the contact register. The program can then create orders for these customers in the Mamut system so that the user avoids duplicating information entries. The user can then go into Mamut and invoice these orders in one operation (or let the API do it), at the same time as the accounting nominal ledger and customer and supplier ledger are updated. Various programs handle invoicing & customer register, payroll calculation and purchasing, but do not have a complete accounting module. Mamut API can then be used to automatically create entry lines/journals in journal entry in the Mamut system to avoid duplicate entry of information.

3 The Mamut API documentation consists of two main sections: The first section covers how information can be changed, added to and read from using the different objects in the API. This communication goes through a dedicated object DLL which is described in more detail in the full documentation. The second section of Mamut API is documentation of the most important tables in the database and how information can be retrieved from modules other than those named above. To retrieve information from modules other than contact, activity, order, payroll, document, time sheet input and product register, ODBC is used. Knowledge of how to utilize ODBC is a prerequisite, and the document consists of explanation of relationships between tables in the database, description of fields in the tables and example codes for how the most usual information can be retrieved. For Mamut ASA to be able to give user support, it is important that nobody should make changes to the content of the database by using ODBC or other tools not developed by Mamut ASA (in accordance with the Mamut License Agreement). It is only possible for Mamut users to change information in the Mamut database through Mamut s normal user interface and by means of methods described in the documentation. Any violation of this is a breach of the Mamut License Agreement, which means that Mamut ASA is not required to provide user support. Mamut API includes functions to search for, change and create new contacts, orders and products. These functions are carried out with the straightforward use of a COM component called GBAAPI. This COM component takes care of all communication with Mamut s database and the user need only tell the component what to do. Mamut API is based on COM technology. By calling on GBAAPI, objects are returning information that can be modified. This means the user can use any tool which supports ActiveX/COM.

4 What is the API? The API- Application Programming Interface is a programmer s tool that allows safe and supported access to the Mamut database. API is a COM object (Common Object Model). This means that any Windows application can use the API to communicate with Mamut as long as the language supports using COM-objects. API is a programmers tool and is commonly used to link 3 rd party systems and Mamut Business Software. API is updated in every new version of Mamut Business Software. API is.net compatible The API has different pricing models depending on your. If unsure whether Mamut API is for you, please send technical questions to api@mamut.com state your customer number if you have one, which Mamut customer/prospect you re working for and let us know that you don t yet have a API license and require more information before purchasing a license. Why use the API? When you need to integrate Mamut with other systems. No barriers! Use the API to connect systems. If you are a reseller that commonly makes links to other systems. If import/export is not able to meet the, API can probably help. A programmer can program any windows application to talk to Mamut using API. Sales Information What do I get when I buy? When you purchase Mamut API you have direct access to the technical support team via the address api@mamut.com. Our specialized support staff is on hand to guide you when using the API. Mamut can supply you with code examples in using the API. We have many code examples in C# and VBScript in our documentation. You will receive the API documentation - a complete listing of API methods and properties with description and examples of use. The API documentation also describes the most important tables, fields and relationships. Not all tables/fields are mentioned as the database is comprised of over 200 tables each with many fields. You can however build your own database diagram using SQL Management Studio (Express). For Mamut ASA to be able to give user support, it is important that nobody should make changes to the content of the database by using ODBC or other tools not developed by Mamut ASA (in accordance with the Mamut License Agreement).

5 The Mamut systems are in continual development and new functions are added and updated with each version. This requires frequent changes to be made in the database. The API documentation therefore comprises only the most central and important tables, fields and relationships - which are not likely to be changed. You will be added to the API news list from which you will receive notification of API updates and increased functionality notification between versions. When not to buy the API? The Mamut API should not by default replace Mamut ImportExport; remember you can automate Mamut ImportExport silently (means that you can also link other systems with Import/Export) to import Contacts, Company Contacts, Products, Orders and Journals automatically. The API is however a more subtle and efficient solution enhancing the integration process. The API requires programming knowledge our API support is on hand regarding technical issues with the API, not training in programming. FAQ Q: Can the API change the Mamut screens, add extra fields? A: No, The API is not a development tool to change the Mamut user interface. Q: Does the API include every field in Mamut? A: No, the API is updated on every release of Mamut and it makes available the most common fields to users. If unsure you should check with Technical support: api@mamut.com Q: I want to link my spreadsheets to Mamut using the API, is this possible? A: Yes, using VBA (Visual Basic for Applications) you can program the API from any MS-Office Application. If unsure you should check with support Q: Can I add custom tables to the Mamut database with the API? A: No, the schema for Mamut is not open, you can however link you own tables Q: Can I run my developed API software on a client without Mamut? A: No, the API requires the core libraries in Mamut client software to run. The machine running the API software must always have Mamut installed. Q: What happens when versions of Mamut change? A: The API is in principle forward compatible between versions, so your users will be able to upgrade in-line with Mamut with no or very few changes to your product. We recommend using Late Binding in programming, making the transition even easier between versions of Mamut / the API. License-holders of the API will have access to beta-versions of Mamut Business Software; enabling you to test forward compatibility before the launch of each major version. Q: In what language should I address api@mamut.com? A: We prefer English in order to ensure a quick and efficient communication

6 Functionality Check List Mamut (examples not a definite list) Contact Module Create/Change Contacts Create/Change most contact fields - check with support if you have specific Create/Change user-defined fields Create/Change contact groups Lookup Contacts Link to Project Add Bank accounts Company Contact Module Create/Change Company Contacts Create/Change most company contact fields - check with support if you have specific Activity Module Create/Change Activities Create/Change most activity fields - check with support if you have specific Lookup an activity Product Module Create/Change Products Create/Change most product fields - check with support if you have specific Look up a product Retrieve Stock count from a warehouse or all warehouses Set stock to a location/warehouse Insert a product that is part of a bundle Order Module Create Orders/Order Lines Access to most order/line fields Lookup an order Invoice an order Find an order line Update the warehouse (when invoicing) Delete orders in an unprocessed state Delete order lines on orders in an unprocessed state Journal Module Create Journals Access to most Journal properties - check with support if you have specific Payroll Module Create Payroll Access to most Payroll properties - check with support if you have specific Document Module Add document-links to Mamut Link documents to contacts/company contacts/activities/employees

7 Employee Module Create /Change employees Access to most Employee properties - check with support if you have specific Add project links to employees TimeSheet Module Create /Change timesheets Access to most timesheet properties - check with support if you have specific Create time lines Transfer to Orders / Projects / Payroll Link to employees / contacts / company contacts / orders Main Module Create Project with name Create Properties register entries Find Country settings Get VAT codes Create Product groups Create Payment terms Create Delivery Method Create Warehouse Create Warehouse locations Add Bank Accounts Add address Get Mamut Version Get API version Get expire date