API Documentation
Authorizing API
In order to use directly the API, you need to authorize your application.
We strongly recommend to give to your app only the permissions that you really need and nothing more; this will increase your security.
Getting an app token
Authorize app with key & secret
https://api.worldsoft-wbs.com/app/auth?company_id={COMPANY_ID}&key={KEY}&secret={SECRET}
- result is app_token. This token is valid 2 hours. In all the next calls, the token need to be used.
Login
https://api.worldsoft-wbs.com/login/login?username={USERNAME}&password={PASSWORD}&app_token={APP_TOKEN}
- result is token
Using other functions
API requests need app_token & token. Of course the permissions should allow using the methods
class CrmCustomers, function search
https://api.worldsoft-wbs.com/crm/customers/search?app_token={APP_TOKEN}&token={TOKEN}
Other parameters will be also added if necessary.
As app_token and token params are for all functions, they are not added to the description of each method again.
Classes available in API
Api
Documentation of the API as HTML
App
App authentication and permissions
Recovery
Password recovery
Calendar
iCalendar
CalendarReferences
iCalendar created url references
CalendarEvents
iCalendar events
CalendarEventsShare
iCalendar events sharing
CalendarEventsNotification
iCalendar events notification
CalendarReservations
iCalendar Reservations
CompanyMessages
Everything about Company messages / Notifications
CompanyMessagesEmails
Email messages
CompanySmsMessages
Sms messages
CompanyMessagesFormrequests
Form requests
CompanyEmailReports
Company Email Reports
CompanyEmailMessages
Company Email Messages Controller
CompanyEmailtemplates
Email templates created by the users
CompanyEmailtemplatesSystem
System Email templates
CompanyEmailtemplatesCategories
Email templates categories
CompanySmstemplates
Sms templates created by the users
CompanySmstemplatesCategories
Sms templates categories
CompanyPdftemplates
PDF templates
CompanyPdftemplatesCategories
PDF templates categories
CompanyBillingTemplates
Billing related templates
CompanyUsers
Company Users (Owner, Employees, Partners etc)
CompanyUsersClients
Assigning clients to users
CompanyDepartments
Company Departments (User Groups)
CompanyProfile
Company Data
CompanyPreferences
CompanyPreferences
CompanyUsage
Information about Space Usage etc
CompanyBackups
Backups - create backups and restore from backups
CrmCustomers
CRM - Customer related functionality
CrmCustomerAddresses
Additional customer addresses (for shipping etc)
CrmCustomerNewsletters
Newsletters related to specific customer
CrmCustomersGroups
Customer Groups
CrmCustomersGroupsLog
Customer Groups Log
CrmCustomersMessages
Customers Messages
CrmFilters
CRM Customer filters
CrmFilterCategories
CRM Customer filters categories
CrmLeadmanagerProjects
Lead Manager - Projects
CrmLeadmanagerStatus
Lead Manager - Project Stati
CrmLeadmanagerProspects
Lead Manager - Prospects - assigning Stati and users
CrmLeadmanagerProjectGroups
Assigning Groups to projects
CrmLeadmanagerProjectCalendars
Assigning Calendars to projects
UserData
User Profile, User data, change Password
UserProfile
User profile
UserLayout
Information for creating the frontend based on User rights
UserPreferences
User relqated preferences
UserNotification
User notifications
BillingDocs
Billing Documents
BillingDocFilterCategories
Billing Document Filter Categories
BillingDocFilters
Billing Document Filters
BillingItems
Billing Items
BillingText
Billing Texts
BillingPromotions
Billing Promotions/Discounts
BillingPromotionGroups
Billing Promotion Groups
BillingArticlesCategories
Article Categories
BillingArticleFilterCategories
Article Filter Categories
BillingArticleFilters
Article Filters
BillingArticleAttributes
Article Attributes
BillingArticleVariations
Article Variations
BillingArticleSuppliers
Article Suppliers
BillingArticles
Articles
BillingArticleRules
Commision rules for articles
BillingArticleImages
Article images
BillingArticleStock
Article stock
BillingARBSubscriptions
ARB subscriptions
BillingCurrencies
Currencies and currency converter
BillingLists
Billing lists
BillingPaymentSEPA
Billing SEPA paymethod
EmsEmailing
Sending Emails
EmsLetters
Creating Letters (PDF)
EmsNewsletter
EMS - Basic Newsletter
EmsNewsletterMailerRules
Tasks(rules) for Newsletter/Campaign/Event
EmsNewsletterMailer
EMS - Newsletter/Campaign/Event
EmsNewsletterSmsMailerRules
Tasks(rules) for SMS Newsletter/Campaign/Event
EmsNewsletterSmsMailer
EMS - SMS Newsletter/Campaign/Event
EmsFollowupNewsletter
Follow up Newsletter
EmsFollowupNewsletterRules
Follow up Newsletter Rules
EmsFollowupSmsNewsletter
Follow up Sms Newsletter
EmsFollowupSmsNewsletterRules
Follow up Sms Newsletter Rules
EmsPolls
Polls
EmsPollOptions
Poll Options
EmsPollQuestions
Poll Questions
EmsPollStyles
Poll styles - CSS
EmsPollAnswers
Poll answers
EmsEmailReports
Email reports
EmsMailing
Mailing
EmsSmsSending
Sms sending
EmsSmsReports
Sms reports
EmsSms
Sms
PwaPushNotifications
PWA Push Notifications
EmsNewsletterSms
EMS - SMS - Basic Newsletter
AffiliateNetworks
Affiliate networks
AffiliateNetworkRegions
Affiliate Regions
AffiliateNetworkRegionsManager
Affiliate Region Manager Link Controller
AffiliateNetworkRegionRules
Affiliate Region defining Rules
AffiliateNetworkEmail
Confirmation Email for joining a Network
AffiliateNetworkOverview
Overview related to a Network
AffiliateNetworkMembers
Assigning members to a network
AffiliateNetworkPlans
Commision plans
AffiliateNetworkPlanRules
Plan rules
SettingsCompany
Company Settings
SettingsCompanyFields
Custom Address Fields
SettingsTitleTags
Tags
SettingsTitle
List of titles (Mr., Ms. etc)
SettingsTitleTranslations
Translations of the titles
SettingsCrmBadges
CRM Badges Settings - define badges for clients
SettingsBillingCurrency
Currency settings
SettingsBillingReminder
Settings related to reminders
SettingsBillingVat
VAT Settings
SettingsBillingShipping
Shipping Settings
SettingsBillingShippingrules
Shipping Rules
SettingsBillingShippingCountries
Shipping Rules for different countries
SettingsBillingVatrules
VAT Rules for different countries
SettingsBillingPaymentMethod
Settings related to payment methods
SettingsBillingPaymentMethodGroup
Settings related to payment methods groups
SettingsBillingPaymentMethodText
Payment specific texts
SettingsBillingBookingaccounts
Booking accounts
SettingsBillingBankaccounts
Bank accounts
SettingsBillingArticlefields
Article custom fields
SettingsBillingFieldLabels
Bill / booking fields translations
SettingsBillingArbPolicies
ARB policies
SettingsBillingStockOptions
Stock Options
SettingsBillingCheckout
Checkouts
SettingsBirthday
Settings related to birthday email
SettingsEmailAccount
Settings email account
SettingsDomainKeys
Settings domain keys
Shop
Shop Controller
ShopOption
Shop Options Controller
ShopDisplay
Shop Display Controller
MailingTask
System emailing tasks
LogMailings
Mailing statistics